xfe-node
Options
All
  • Public
  • Public/Protected
  • All
Menu

X-Force Exchange Node SDK

Info Badges
License Apache license
Testing Build Status Coverage Status
Quality Dependencies status
Stats NPM Image Downloads

Description

The X-Force Exchange Node SDK is a Node.js library for interacting with the IBM X-Force Exchange. It provides a wrapper around the API which you can use directly and also provides some convenience functionality.

Installation

First, install npm on your machine. Then install the library in your project with

npm install xfe --save

How to Use

Obtain an API username and password

var xfe = require("xfe");
var xfeClient = new xfe("api username", "api password");

xfeClient.ipr.get("1.2.3.4").then(function(response) {
  console.log(response);
})

View full interface documentation here.

Support

If you are having any questions or issues getting things to work, you can:

Project's issue on GitHub should be used discuss bugs and features.

Contributing to the project

We welcome any contributions to the project. Please check the CONTRIBUTING.md for contribution guidelines.

Check out our contributors here

Development

Prepare your environment

  • Install Node.js and NPM (should come with)
  • Install global dev dependencies: npm install -g gulp
  • Install local dev dependencies: npm install while current directory is xfe-node repo

Build

  • Build the whole project: gulp - this will run lint, build, and test targets

Release

  • Use GitHub's release tool to draft and publish a release. I like the format better than changelogs.

Index

External modules

"app/app"

"app/app":

default

default:

constructor

  • new default(username: string, password: string): default
  • Creates an XFE API Binding

    Parameters

    • username: string

      XFE API Username

    • password: string

      XFE API Password

    Returns default

collections

collections: Collections

files

files: Files

iap

iap: IAP

ipr

ipr: IPR

url

url: URL

"app/collections"

"app/collections":

Collection

Collection:

constructor

  • new Collection(request: any, CollectionID: string): Collection

acl

acl: any

collectionID

collectionID: string

link

link: string

request

request: any

shareWith

Collections

Collections:

constructor

  • new Collections(username: string, password: string): Collections

request

request: any

create

delete

  • delete(collectionID: string): Promise<Object>

get

"app/config"

"app/config":

apiUrl

apiUrl: string

webUrl

webUrl: string

"app/files"

"app/files":

Files

Files:

constructor

  • new Files(username: string, password: string): Files
  • Creates an File Analysis object

    Parameters

    • username: string

      XFE API Username

    • password: string

      XFE API Password

    Returns Files

request

request: any

getIntel

  • getIntel(filePath: string): Promise<Object>
  • Parameters

    • filePath: string

    Returns Promise<Object>

"app/iap"

"app/iap":

IAP

IAP:

constructor

  • new IAP(username: string, password: string): IAP
  • Creates an IAP object

    Parameters

    • username: string

      XFE API Username

    • password: string

      XFE API Password

    Returns IAP

request

request: any

get

  • get(appName: string): Promise<Object>
  • Get IAP Address Threat Intelligence

    example

    // Returns intelligence about a web app var iapInstance = new IAP("username", "password"); IAP.get("facebook").then(function(response) { console.log(response) });

    Parameters

    • appName: string

      App Name (like facebook) to get threat intelligence for

    Returns Promise<Object>

"app/interfaces/collection"

"app/interfaces/collection":

ShareLevel

ShareLevel:

Contribute

Contribute: string

Read

Read: string

Shared

Shared:

Mine

Mine: string

Public

Public: string

Shared

Shared: string

CollectionRetreival

CollectionRetreival:

collectionID

collectionID: string

type

type: Shared

CollectionShare

CollectionShare:

email

email: string

level

level: ShareLevel

ICollection

ICollection:

acl

acl: any

collectionID

collectionID: string

contents

contents: object

Type declaration

  • reports: Array<any>
  • wiki: string

created

created: Date

deletable

deletable: boolean

link

link: string

mine

mine: boolean

nPeople

nPeople: number

owner

owner: object

Type declaration

  • name: string

shared

shared: Shared

title

title: string

writeable

writeable: boolean

"app/interfaces/collectionCreation"

"app/interfaces/collectionCreation":

CollectionCreation

CollectionCreation:

contents

contents: any

filePath

filePath: string

title

title: string

"app/ipr"

"app/ipr":

IPR

IPR:

constructor

  • new IPR(username: string, password: string): IPR
  • Creates an IPR object

    Parameters

    • username: string

      XFE API Username

    • password: string

      XFE API Password

    Returns IPR

request

request: any

get

  • get(ipAddress: string): Promise<Object>
  • Get IP Address Threat Intelligence

    Parameters

    • ipAddress: string

      IPv4/IPv6 Address to get threat intelligence for

    Returns Promise<Object>

"app/url"

"app/url":

URL

URL:

constructor

  • new URL(username: string, password: string): URL
  • Creates an URL object

    Parameters

    • username: string

      XFE API Username

    • password: string

      XFE API Password

    Returns URL

request

request: any

get

  • get(url: string): Promise<Object>
  • Get URL Threat Intelligence

    Parameters

    • url: string

      URL to search for

    Returns Promise<Object>

    Returns a promise with the response

"typings/main.d"

"typings/main.d":

"typings/main/ambient/assertion-error/index.d"

"typings/main/ambient/assertion-error/index.d":

"assertion-error"

"assertion-error":

AssertionError

AssertionError:

constructor

  • new AssertionError(message: string, props?: any, ssf?: Function): AssertionError
  • Parameters

    • message: string
    • Optional props: any
    • Optional ssf: Function

    Returns AssertionError

message

message: string

name

name: string

showDiff

showDiff: boolean

stack

stack: string

"typings/main/ambient/chai/index.d"

"typings/main/ambient/chai/index.d":

"chai"

"chai":

Chai

Chai:

AssertionError

AssertionError:

constructor

  • new AssertionError(message: string, _props?: any, ssf?: Function): AssertionError
  • Parameters

    • message: string
    • Optional _props: any
    • Optional ssf: Function

    Returns AssertionError

message

message: string

name

name: string

showDiff

showDiff: boolean

stack

stack: string

Assert

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

approximately

  • approximately(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

extensible

  • extensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

frozen

  • frozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(superset: any[], subset: any[], msg?: string): void
  • Parameters

    • superset: any[]
    • subset: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isAbove

  • isAbove(val: number, abv: number, msg?: string): void
  • Parameters

    • val: number
    • abv: number
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isAtLeast

  • isAtLeast(val: number, atlst: number, msg?: string): void
  • Parameters

    • val: number
    • atlst: number
    • Optional msg: string

    Returns void

isAtMost

  • isAtMost(val: number, atmst: number, msg?: string): void
  • Parameters

    • val: number
    • atmst: number
    • Optional msg: string

    Returns void

isBelow

  • isBelow(val: number, blw: number, msg?: string): void
  • Parameters

    • val: number
    • blw: number
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isExtensible

  • isExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFrozen

  • isFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNaN

  • isNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotExtensible

  • isNotExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotFalse

  • isNotFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotFrozen

  • isNotFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNaN

  • isNotNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotOk

  • isNotOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotSealed

  • isNotSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotTrue

  • isNotTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isOk

  • isOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isSealed

  • isSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notExtensible

  • notExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notFrozen

  • notFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notSealed

  • notSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

oneOf

  • oneOf(inList: any, list: any[], msg?: string): void
  • Parameters

    • inList: any
    • list: any[]
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameDeepMembers

  • sameDeepMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sealed

  • sealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

AssertStatic

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

approximately

  • approximately(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

extensible

  • extensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

frozen

  • frozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(superset: any[], subset: any[], msg?: string): void
  • Parameters

    • superset: any[]
    • subset: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isAbove

  • isAbove(val: number, abv: number, msg?: string): void
  • Parameters

    • val: number
    • abv: number
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isAtLeast

  • isAtLeast(val: number, atlst: number, msg?: string): void
  • Parameters

    • val: number
    • atlst: number
    • Optional msg: string

    Returns void

isAtMost

  • isAtMost(val: number, atmst: number, msg?: string): void
  • Parameters

    • val: number
    • atmst: number
    • Optional msg: string

    Returns void

isBelow

  • isBelow(val: number, blw: number, msg?: string): void
  • Parameters

    • val: number
    • blw: number
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isExtensible

  • isExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFrozen

  • isFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNaN

  • isNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotExtensible

  • isNotExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotFalse

  • isNotFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotFrozen

  • isNotFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNaN

  • isNotNaN(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotOk

  • isNotOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotSealed

  • isNotSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotTrue

  • isNotTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isOk

  • isOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isSealed

  • isSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notExtensible

  • notExtensible(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notFrozen

  • notFrozen(obj: Object, msg?: string): void
  • Parameters

    • obj: Object
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notSealed

  • notSealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

oneOf

  • oneOf(inList: any, list: any[], msg?: string): void
  • Parameters

    • inList: any
    • list: any[]
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameDeepMembers

  • sameDeepMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

sealed

  • sealed(obj: object, msg?: string): void
  • Parameters

    • obj: object
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

Assertion

  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

Arguments

Arguments: Assertion

NaN

Throw

Throw: Throw

a

above

all

an

and

any

approximately

approximately: CloseTo

arguments

arguments: Assertion

at

be

been

been: Assertion

below

change

changes

closeTo

closeTo: CloseTo

contain

contain: Include

contains

contains: Include

decrease

decrease: PropertyChange

decreases

decreases: PropertyChange

deep

deep: Deep

empty

empty: Assertion

eq

eq: Equal

eql

eql: Equal

eqls

eqls: Equal

equal

equal: Equal

equals

equals: Equal

exist

exist: Assertion

extensible

extensible: Assertion

false

false: Assertion

frozen

frozen: Assertion

greaterThan

greaterThan: NumberComparer

gt

gte

has

have

have: Assertion

haveOwnProperty

haveOwnProperty: OwnProperty

haveOwnPropertyDescriptor

haveOwnPropertyDescriptor: OwnPropertyDescriptor

include

include: Include

includes

includes: Include

increase

increase: PropertyChange

increases

increases: PropertyChange

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

is

itself

itself: Assertion

keys

keys: Keys

least

length

length: Length

lengthOf

lengthOf: Length

lessThan

lessThan: NumberComparer

lt

lte

match

match: Match

matches

matches: Match

members

members: Members

most

not

null

null: Assertion

of

ok

ownProperty

ownProperty: OwnProperty

ownPropertyDescriptor

ownPropertyDescriptor: OwnPropertyDescriptor

property

property: Property

respondTo

respondTo: RespondTo

respondsTo

respondsTo: RespondTo

same

same: Assertion

satisfies

satisfies: Satisfy

satisfy

satisfy: Satisfy

sealed

sealed: Assertion

that

that: Assertion

throw

throw: Throw

throws

throws: Throw

to

true

true: Assertion

undefined

undefined: Assertion

which

which: Assertion

with

with: Assertion

key

  • Parameters

    • string: string

    Returns Assertion

oneOf

  • oneOf(list: any[], message?: string): Assertion
  • Parameters

    • list: any[]
    • Optional message: string

    Returns Assertion

string

  • string(string: string, message?: string): Assertion
  • Parameters

    • string: string
    • Optional message: string

    Returns Assertion

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

AssertionStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

ChaiStatic

ChaiStatic:

AssertionError

AssertionError: AssertionError

assert

assert: AssertStatic

config

config: Config

expect

expect: ExpectStatic

should

  • Returns Should

use

  • use(fn: function): any
  • Provides a way to extend the internals of Chai

    Parameters

    • fn: function
        • (chai: any, utils: any): void
        • Parameters

          • chai: any
          • utils: any

          Returns void

    Returns any

CloseTo

  • __call(expected: number, delta: number, message?: string): Assertion
  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns Assertion

Config

Config:

includeStack

includeStack: boolean

Deep

Deep:

equal

equal: Equal

include

include: Include

members

members: Members

property

property: Property

Equal

  • __call(value: any, message?: string): Assertion
  • Parameters

    • value: any
    • Optional message: string

    Returns Assertion

ExpectStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

Include

  • __call(value: Object, message?: string): Assertion
  • __call(value: string, message?: string): Assertion
  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: Object
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

all

any

keys

keys: Keys

members

members: Members

InstanceOf

  • __call(constructor: Object, message?: string): Assertion
  • Parameters

    • constructor: Object
    • Optional message: string

    Returns Assertion

KeyFilter

KeyFilter:

keys

keys: Keys

Keys

  • Parameters

    • Rest ...keys: string[]

    Returns Assertion

  • Parameters

    • keys: any[]

    Returns Assertion

  • Parameters

    • keys: Object

    Returns Assertion

LanguageChains

LanguageChains:

and

at

be

been

been: Assertion

has

have

have: Assertion

is

of

same

same: Assertion

that

that: Assertion

to

which

which: Assertion

with

with: Assertion

Length

  • __call(length: number, message?: string): Assertion
  • Parameters

    • length: number
    • Optional message: string

    Returns Assertion

above

and

at

be

been

been: Assertion

below

greaterThan

greaterThan: NumberComparer

gt

gte

has

have

have: Assertion

is

least

lessThan

lessThan: NumberComparer

lt

lte

most

of

same

same: Assertion

that

that: Assertion

to

which

which: Assertion

with

with: Assertion

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

Match

  • __call(regexp: RegExp | string, message?: string): Assertion
  • Parameters

    • regexp: RegExp | string
    • Optional message: string

    Returns Assertion

Members

  • __call(set: any[], message?: string): Assertion
  • Parameters

    • set: any[]
    • Optional message: string

    Returns Assertion

NumberComparer

  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

NumericComparison

NumericComparison:

above

below

greaterThan

greaterThan: NumberComparer

gt

gte

least

lessThan

lessThan: NumberComparer

lt

lte

most

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

OwnProperty

  • __call(name: string, message?: string): Assertion
  • Parameters

    • name: string
    • Optional message: string

    Returns Assertion

OwnPropertyDescriptor

  • __call(name: string, descriptor: PropertyDescriptor, message?: string): Assertion
  • __call(name: string, message?: string): Assertion
  • Parameters

    • name: string
    • descriptor: PropertyDescriptor
    • Optional message: string

    Returns Assertion

  • Parameters

    • name: string
    • Optional message: string

    Returns Assertion

Property

  • __call(name: string, value?: any, message?: string): Assertion
  • Parameters

    • name: string
    • Optional value: any
    • Optional message: string

    Returns Assertion

PropertyChange

  • __call(object: Object, prop: string, msg?: string): Assertion
  • Parameters

    • object: Object
    • prop: string
    • Optional msg: string

    Returns Assertion

RespondTo

  • __call(method: string, message?: string): Assertion
  • Parameters

    • method: string
    • Optional message: string

    Returns Assertion

Satisfy

  • __call(matcher: Function, message?: string): Assertion
  • Parameters

    • matcher: Function
    • Optional message: string

    Returns Assertion

Should

Should:

Throw

not

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

fail

  • fail(actual: any, expected: any, message?: string, operator?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ShouldAssertion

ShouldAssertion:

Throw

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

ShouldThrow

  • __call(actual: Function): void
  • __call(actual: Function, expected: string | RegExp, message?: string): void
  • __call(actual: Function, constructor: Error | Function, expected?: string | RegExp, message?: string): void
  • Parameters

    • actual: Function

    Returns void

  • Parameters

    • actual: Function
    • expected: string | RegExp
    • Optional message: string

    Returns void

  • Parameters

    • actual: Function
    • constructor: Error | Function
    • Optional expected: string | RegExp
    • Optional message: string

    Returns void

Throw

  • __call(): Assertion
  • __call(expected: string, message?: string): Assertion
  • __call(expected: RegExp, message?: string): Assertion
  • __call(constructor: Error, expected?: string, message?: string): Assertion
  • __call(constructor: Error, expected?: RegExp, message?: string): Assertion
  • __call(constructor: Function, expected?: string, message?: string): Assertion
  • __call(constructor: Function, expected?: RegExp, message?: string): Assertion
  • Returns Assertion

  • Parameters

    • expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

TypeComparison

  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

Object

Object:

should

should: Assertion

chai

"typings/main/ambient/form-data/index.d"

"typings/main/ambient/form-data/index.d":

"form-data"

"form-data":

FormData

FormData:

append

  • append(key: string, value: any, options?: any): FormData
  • Parameters

    • key: string
    • value: any
    • Optional options: any

    Returns FormData

getHeaders

  • getHeaders(): Object
  • Returns Object

pipe

  • pipe(to: any): any
  • Parameters

    • to: any

    Returns any

submit

  • submit(params: string | Object, callback: function): any
  • Parameters

    • params: string | Object
    • callback: function
        • (error: any, response: any): void
        • Parameters

          • error: any
          • response: any

          Returns void

    Returns any

"typings/main/ambient/lodash/index.d"

"typings/main/ambient/lodash/index.d":

"lodash"

"lodash":

_

TODO:

removed:

  • [x] Removed _.support
  • [x] Removed .findWhere in favor of .find with iteratee shorthand
  • [x] Removed .where in favor of .filter with iteratee shorthand
  • [x] Removed .pluck in favor of .map with iteratee shorthand

renamed:

  • [x] Renamed .first to .head
  • [x] Renamed .indexBy to .keyBy
  • [x] Renamed .invoke to .invokeMap
  • [x] Renamed .overArgs to .overArgs
  • [x] Renamed .padLeft & .padRight to .padStart & .padEnd
  • [x] Renamed .pairs to .toPairs
  • [x] Renamed .rest to .tail
  • [x] Renamed .restParam to .rest
  • [x] Renamed .sortByOrder to .orderBy
  • [x] Renamed .trimLeft & .trimRight to .trimStart & .trimEnd
  • [x] Renamed .trunc to .truncate

split:

  • [x] Split .indexOf & .lastIndexOf into .sortedIndexOf & .sortedLastIndexOf
  • [x] Split .max & .min into .maxBy & .minBy
  • [x] Split .omit & .pick into .omitBy & .pickBy
  • [x] Split .sample into .sampleSize
  • [x] Split .sortedIndex into .sortedIndexBy
  • [x] Split .sortedLastIndex into .sortedLastIndexBy
  • [x] Split .uniq into .sortedUniq, .sortedUniqBy, & .uniqBy

changes:

  • [x] Absorbed .sortByAll into .sortBy
  • [x] Changed the category of _.at to “Object”
  • [x] Changed the category of _.bindAll to “Utility”
  • [x] Made _.capitalize uppercase the first character & lowercase the rest
  • [x] Made _.functions return only own method names

added 23 array methods:

  • [x] _.concat
  • [x] _.differenceBy
  • [x] _.differenceWith
  • [x] _.flatMap
  • [x] _.fromPairs
  • [x] _.intersectionBy
  • [x] _.intersectionWith
  • [x] _.join
  • [x] _.pullAll
  • [x] _.pullAllBy
  • [x] _.reverse
  • [x] _.sortedIndexBy
  • [x] _.sortedIndexOf
  • [x] _.sortedLastIndexBy
  • [x] _.sortedLastIndexOf
  • [x] _.sortedUniq
  • [x] _.sortedUniqBy
  • [x] _.unionBy
  • [x] _.unionWith
  • [x] _.uniqBy
  • [x] _.uniqWith
  • [x] _.xorBy
  • [x] _.xorWith

added 18 lang methods:

  • [x] _.cloneDeepWith
  • [x] _.cloneWith
  • [x] _.eq
  • [x] _.isArrayLike
  • [x] _.isArrayLikeObject
  • [x] _.isEqualWith
  • [x] _.isInteger
  • [x] _.isLength
  • [x] _.isMatchWith
  • [x] _.isNil
  • [x] _.isObjectLike
  • [x] _.isSafeInteger
  • [x] _.isSymbol
  • [x] _.toInteger
  • [x] _.toLength
  • [x] _.toNumber
  • [x] _.toSafeInteger
  • [x] _.toString

added 13 object methods:

  • [x] _.assignIn
  • [x] _.assignInWith
  • [x] _.assignWith
  • [x] _.functionsIn
  • [x] _.hasIn
  • [x] _.mergeWith
  • [x] _.omitBy
  • [x] _.pickBy

added 8 string methods:

  • [x] _.lowerCase
  • [x] _.lowerFirst
  • [x] _.upperCase
  • [x] _.upperFirst
  • [x] _.toLower
  • [x] _.toUpper

added 8 utility methods:

  • [x] _.toPath

added 4 math methods:

  • [x] _.maxBy
  • [x] _.mean
  • [x] _.minBy
  • [x] _.sumBy

added 2 function methods:

  • [x] _.flip
  • [x] _.unary

added 2 number methods:

  • [x] _.clamp
  • [x] _.subtract

added collection method:

  • [x] _.sampleSize

Added 3 aliases

  • [x] .first as an alias of .head

Removed 17 aliases

  • [x] Removed aliase _.all
  • [x] Removed aliase _.any
  • [x] Removed aliase _.backflow
  • [x] Removed aliase _.callback
  • [x] Removed aliase _.collect
  • [x] Removed aliase _.compose
  • [x] Removed aliase _.contains
  • [x] Removed aliase _.detect
  • [x] Removed aliase _.foldl
  • [x] Removed aliase _.foldr
  • [x] Removed aliase _.include
  • [x] Removed aliase _.inject
  • [x] Removed aliase _.methods
  • [x] Removed aliase _.object
  • [x] Removed aliase _.run
  • [x] Removed aliase _.select
  • [x] Removed aliase _.unique

Other changes

  • [x] Added support for array buffers to _.isEqual
  • [x] Added support for converting iterators to _.toArray
  • [x] Added support for deep paths to _.zipObject
  • [x] Changed UMD to export to window or self when available regardless of other exports
  • [x] Ensured debounce cancel clears args & thisArg references
  • [x] Ensured .add, .subtract, & _.sum don’t skip NaN values
  • [x] Ensured _.clone treats generators like functions
  • [x] Ensured _.clone produces clones with the source’s [[Prototype]]
  • [x] Ensured _.defaults assigns properties that shadow Object.prototype
  • [x] Ensured _.defaultsDeep doesn’t merge a string into an array
  • [x] Ensured .defaultsDeep & .merge don’t modify sources
  • [x] Ensured _.defaultsDeep works with circular references
  • [x] Ensured _.keys skips “length” on strict mode arguments objects in Safari 9
  • [x] Ensured _.merge doesn’t convert strings to arrays
  • [x] Ensured _.merge merges plain-objects onto non plain-objects
  • [x] Ensured _#plant resets iterator data of cloned sequences
  • [x] Ensured _.random swaps min & max if min is greater than max
  • [x] Ensured _.range preserves the sign of start of -0
  • [x] Ensured .reduce & .reduceRight use getIteratee in their array branch
  • [x] Fixed rounding issue with the precision param of _.floor

  • LATER ** Misc:

  • [ ] Made .forEach, .forIn, .forOwn, & .times implicitly end a chain sequence
  • [ ] Removed thisArg params from most methods
  • [ ] Made “By” methods provide a single param to iteratees
  • [ ] Made _.words chainable by default
  • [ ] Removed isDeep params from .clone & .flatten
  • [ ] Removed _.bindAll support for binding all methods when no names are provided
  • [ ] Removed func-first param signature from .before & .after
  • [ ] .extend as an alias of .assignIn
  • [ ] .extendWith as an alias of .assignInWith
  • [ ] Added clear method to _.memoize.Cache
  • [ ] Added flush method to debounced & throttled functions
  • [ ] Added support for ES6 maps, sets, & symbols to .clone, .isEqual, & _.toArray
  • [ ] Enabled .flow & .flowRight to accept an array of functions
  • [ ] Ensured “Collection” methods treat functions as objects
  • [ ] Ensured .assign, .defaults, & _.merge coerce object values to objects
  • [ ] Ensured _.bindKey bound functions call object[key] when called with the new operator
  • [ ] Ensured _.isFunction returns true for generator functions
  • [ ] Ensured _.merge assigns typed arrays directly
  • [ ] Made _(...) an iterator & iterable
  • [ ] Made .drop, .take, & right forms coerce n of undefined to 0

Methods:

  • [ ] _.concat
  • [ ] _.differenceBy
  • [ ] _.differenceWith
  • [ ] _.flatMap
  • [ ] _.fromPairs
  • [ ] _.intersectionBy
  • [ ] _.intersectionWith
  • [ ] _.join
  • [ ] _.pullAll
  • [ ] _.pullAllBy
  • [ ] _.reverse
  • [ ] _.sortedLastIndexOf
  • [ ] _.unionBy
  • [ ] _.unionWith
  • [ ] _.uniqWith
  • [ ] _.xorBy
  • [ ] _.xorWith
  • [ ] _.toString

  • [ ] _.invoke

  • [ ] _.setWith
  • [ ] _.toPairs
  • [ ] _.toPairsIn
  • [ ] _.unset

  • [ ] _.replace

  • [ ] _.split

  • [ ] _.cond

  • [ ] _.conforms
  • [ ] _.nthArg
  • [ ] _.over
  • [ ] _.overEvery
  • [ ] _.overSome
  • [ ] _.rangeRight

  • [ ] _.next

AssignCustomizer

  • __call(objectValue: any, sourceValue: any, key?: string, object?: object, source?: object): any
  • __call(objectValue: any, sourceValue: any, key?: string, object?: object, source?: object): any
  • Parameters

    • objectValue: any
    • sourceValue: any
    • Optional key: string
    • Optional object: object
    • Optional source: object

    Returns any

  • Parameters

    • objectValue: any
    • sourceValue: any
    • Optional key: string
    • Optional object: object
    • Optional source: object

    Returns any

Cancelable

Cancelable:

cancel

  • cancel(): void
  • Returns void

CurriedFunction1

  • Returns CurriedFunction1<T1, R>

  • Parameters

    • t1: T1

    Returns R

CurriedFunction2

  • Returns CurriedFunction2<T1, T2, R>

  • Parameters

    • t1: T1

    Returns CurriedFunction1<T2, R>

  • Parameters

    • t1: T1
    • t2: T2

    Returns R

CurriedFunction3

  • Returns CurriedFunction3<T1, T2, T3, R>

  • Parameters

    • t1: T1

    Returns CurriedFunction2<T2, T3, R>

  • Parameters

    • t1: T1
    • t2: T2

    Returns CurriedFunction1<T3, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3

    Returns R

CurriedFunction4

  • Returns CurriedFunction4<T1, T2, T3, T4, R>

  • Parameters

    • t1: T1

    Returns CurriedFunction3<T2, T3, T4, R>

  • Parameters

    • t1: T1
    • t2: T2

    Returns CurriedFunction2<T3, T4, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3

    Returns CurriedFunction1<T4, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3
    • t4: T4

    Returns R

CurriedFunction5

  • Returns CurriedFunction5<T1, T2, T3, T4, T5, R>

  • Parameters

    • t1: T1

    Returns CurriedFunction4<T2, T3, T4, T5, R>

  • Parameters

    • t1: T1
    • t2: T2

    Returns CurriedFunction3<T3, T4, T5, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3

    Returns CurriedFunction2<T4, T5, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3
    • t4: T4

    Returns CurriedFunction1<T5, R>

  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3
    • t4: T4
    • t5: T5

    Returns R

DebounceSettings

DebounceSettings:

leading

leading: boolean

Specify invoking on the leading edge of the timeout.

maxWait

maxWait: number

The maximum time func is allowed to be delayed before it’s invoked.

trailing

trailing: boolean

Specify invoking on the trailing edge of the timeout.

Dictionary

Dictionary:

DictionaryIterator

  • __call(value: T, key?: string, collection?: Dictionary<T>): TResult
  • Parameters

    • value: T
    • Optional key: string
    • Optional collection: Dictionary<T>

    Returns TResult

Function0

  • __call(): R
  • Returns R

Function1

  • __call(t1: T1): R
  • Parameters

    • t1: T1

    Returns R

Function2

  • __call(t1: T1, t2: T2): R
  • Parameters

    • t1: T1
    • t2: T2

    Returns R

Function3

  • __call(t1: T1, t2: T2, t3: T3): R
  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3

    Returns R

Function4

  • __call(t1: T1, t2: T2, t3: T3, t4: T4): R
  • Parameters

    • t1: T1
    • t2: T2
    • t3: T3
    • t4: T4

    Returns R

FunctionBind

  • __call<T, TResult>(func: T, thisArg: any, ...partials: any[]): TResult
  • __call<TResult>(func: Function, thisArg: any, ...partials: any[]): TResult
  • Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T
    • thisArg: any
    • Rest ...partials: any[]

    Returns TResult

  • Type parameters

    • TResult: Function

    Parameters

    • func: Function
    • thisArg: any
    • Rest ...partials: any[]

    Returns TResult

placeholder

placeholder: any

FunctionBindKey

  • __call<T, TResult>(object: T, key: any, ...partials: any[]): TResult
  • __call<TResult>(object: Object, key: any, ...partials: any[]): TResult
  • Type parameters

    • T: Object

    • TResult: Function

    Parameters

    • object: T
    • key: any
    • Rest ...partials: any[]

    Returns TResult

  • Type parameters

    • TResult: Function

    Parameters

    • object: Object
    • key: any
    • Rest ...partials: any[]

    Returns TResult

placeholder

placeholder: any

IsEqualCustomizer

  • __call(value: any, other: any, indexOrKey?: number | string): boolean
  • Parameters

    • value: any
    • other: any
    • Optional indexOrKey: number | string

    Returns boolean

List

List:

length

length: number

ListIterator

  • __call(value: T, index: number, collection: List<T>): TResult
  • Parameters

    • value: T
    • index: number
    • collection: List<T>

    Returns TResult

ListOfRecursiveArraysOrValues

ListOfRecursiveArraysOrValues:

length

length: number

LoDashExplicitArrayWrapper

LoDashExplicitArrayWrapper:

at

  • see

    _.at

    Parameters

    • Rest ...props: number | string | Array<number | string>

    Returns LoDashExplicitArrayWrapper<T>

chain

chunk

  • see

    _.chunk

    Parameters

    • Optional size: number

    Returns LoDashExplicitArrayWrapper<T[]>

commit

compact

concat

constant

countBy

difference

  • see

    _.difference

    Parameters

    • Rest ...values: Array<T> | List<T>

    Returns LoDashExplicitArrayWrapper<T>

differenceBy

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Rest ...values: any[]

    Returns LoDashExplicitArrayWrapper<T>

drop

  • see

    _.drop

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<T>

dropRight

  • see

    _.dropRight

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<T>

dropRightWhile

  • see

    _.dropRightWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.dropRightWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.dropRightWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<T>

dropWhile

  • see

    _.dropWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.dropWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.dropWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<T>

each

eachRight

eq

every

  • see

    _.every

    Parameters

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.every

    Parameters

    • Optional predicate: string | any[]

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.every

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns LoDashExplicitWrapper<boolean>

fill

  • see

    _.fill

    Type parameters

    • T

    Parameters

    • value: T
    • Optional start: number
    • Optional end: number

    Returns LoDashExplicitArrayWrapper<T>

filter

  • see

    _.filter

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.filter

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    Parameters

    • predicate: W

    Returns LoDashExplicitArrayWrapper<T>

findIndex

  • see

    _.findIndex

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitWrapper<number>

findLastIndex

  • see

    _.findLastIndex

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findLastIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findLastIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitWrapper<number>

flatten

  • see

    _.flatten

    Type parameters

    • TResult

    Parameters

    • Optional isDeep: boolean

    Returns LoDashExplicitArrayWrapper<TResult>

flattenDeep

  • see

    _.flattenDeep

    Type parameters

    • T

    Returns LoDashExplicitArrayWrapper<T>

forEach

forEachRight

groupBy

gt

gte

includes

  • see

    _.includes

    Parameters

    • target: T
    • Optional fromIndex: number

    Returns LoDashExplicitWrapper<boolean>

indexOf

  • see

    _.indexOf

    Parameters

    • value: T
    • Optional fromIndex: boolean | number

    Returns LoDashExplicitWrapper<number>

initial

intersection

  • see

    _.intersection

    Type parameters

    • TResult

    Parameters

    • Rest ...arrays: Array<TResult> | List<TResult>

    Returns LoDashExplicitArrayWrapper<TResult>

invokeMap

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns LoDashExplicitArrayWrapper<TResult>

isArguments

isArray

isArrayLike

isArrayLikeObject

isBoolean

isDate

isElement

isEmpty

isEqual

isEqualWith

isError

isFinite

isFunction

isInteger

isLength

isNaN

isNative

isNil

isNull

isNumber

isObject

isObjectLike

isPlainObject

isRegExp

isSafeInteger

isString

isSymbol

isTypedArray

isUndefined

join

  • see

    _.join

    Parameters

    • Optional separator: string

    Returns LoDashExplicitWrapper<string>

keyBy

last

lastIndexOf

  • see

    _.lastIndexOf

    Parameters

    • value: T
    • Optional fromIndex: boolean | number

    Returns LoDashExplicitWrapper<number>

lt

lte

map

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • Optional iteratee: ListIterator<T, TResult>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • Optional iteratee: string

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TObject: object

    Parameters

    • Optional iteratee: TObject

    Returns LoDashExplicitArrayWrapper<boolean>

mapKeys

matches

matchesProperty

method

  • see

    _.method

    Type parameters

    • TObject

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<function>

noop

now

orderBy

  • see

    _.orderBy

    Type parameters

    • W: Object

    Parameters

    • iteratees: ListIterator<T, any> | string | W | ListIterator<T, any> | string | W
    • Optional orders: boolean | string | boolean | string

    Returns LoDashExplicitArrayWrapper<T>

over

  • see

    _.over

    Type parameters

    • TResult

    Parameters

    • Rest ...iteratees: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

overEvery

  • see

    _.overEvery

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

overSome

  • see

    _.overSome

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

plant

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashExplicitObjectWrapper<function>

pull

  • see

    _.pull

    Parameters

    • Rest ...values: T[]

    Returns LoDashExplicitArrayWrapper<T>

pullAt

  • see

    _.pullAt

    Parameters

    • Rest ...indexes: number | Array<number>

    Returns LoDashExplicitArrayWrapper<T>

reject

  • see

    _.reject

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.reject

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • W

    Parameters

    • predicate: W

    Returns LoDashExplicitArrayWrapper<T>

remove

  • see

    _.remove

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.remove

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.remove

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitArrayWrapper<T>

reverse

shuffle

size

  • see

    _.size

    Returns LoDashExplicitWrapper<number>

slice

  • see

    _.slice

    Parameters

    • Optional start: number
    • Optional end: number

    Returns LoDashExplicitArrayWrapper<T>

some

  • see

    _.some

    Parameters

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.some

    Parameters

    • Optional predicate: string | any[]

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.some

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns LoDashExplicitWrapper<boolean>

sortBy

sortedIndex

  • see

    _.sortedIndex

    Type parameters

    • TSort

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndex

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndex

    Type parameters

    • W

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

sortedIndexBy

  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Parameters

    • value: T
    • iteratee: string

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Type parameters

    • W

    Parameters

    • value: T
    • iteratee: W

    Returns LoDashExplicitWrapper<number>

sortedIndexOf

  • see

    _.sortedIndexOf

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

sortedLastIndex

  • see

    _.sortedLastIndex

    Type parameters

    • TSort

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndex

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

sortedLastIndexBy

  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Parameters

    • value: T
    • iteratee: string

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    Parameters

    • value: T
    • iteratee: W

    Returns LoDashExplicitWrapper<number>

sortedUniq

sortedUniqBy

  • see

    _.sortedUniqBy

    Type parameters

    • TSort

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Parameters

    • iteratee: string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • TWhere: object

    Parameters

    • iteratee: TWhere

    Returns LoDashExplicitArrayWrapper<T>

sum

  • see

    _.sum

    Returns LoDashExplicitWrapper<number>

sumBy

  • see

    _.sumBy

    Parameters

    Returns LoDashExplicitWrapper<number>

  • see

    _.sumBy

    Parameters

    • iteratee: string

    Returns LoDashExplicitWrapper<number>

  • see

    _.sumBy

    Returns LoDashExplicitWrapper<number>

tail

take

  • see

    _.take

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<T>

takeRight

  • see

    _.takeRight

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<T>

takeRightWhile

  • see

    _.takeRightWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.takeRightWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.takeRightWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<T>

takeWhile

  • see

    _.takeWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.takeWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.takeWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<T>

tap

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T[]): TResult[]
        • Parameters

          • value: T[]

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

toArray

toInteger

toLength

toNumber

toPath

toSafeInteger

union

  • see

    _.union

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T>

unionBy

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Rest ...iteratee: any[]

    Returns LoDashExplicitArrayWrapper<T>

uniq

uniqBy

  • see

    _.uniqBy

    Type parameters

    • TSort

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Parameters

    • iteratee: string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • TWhere: object

    Parameters

    • iteratee: TWhere

    Returns LoDashExplicitArrayWrapper<T>

unzip

without

  • see

    _.without

    Parameters

    • Rest ...values: T[]

    Returns LoDashExplicitArrayWrapper<T>

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashExplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashExplicitObjectWrapper<R>

xor

zip

  • see

    _.zip

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T[]>

zipObject

  • see

    _.zipObject

    Type parameters

    • TValues

    • TResult: object

    Parameters

    • Optional values: List<TValues>

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    • Optional values: List<any>

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Parameters

    • Optional values: List<any>

    Returns LoDashExplicitObjectWrapper<Dictionary<any>>

LoDashExplicitNumberArrayWrapper

LoDashExplicitNumberArrayWrapper:

at

chunk

compact

countBy

difference

differenceBy

drop

dropRight

dropRightWhile

dropWhile

each

eachRight

every

fill

filter

findIndex

findLastIndex

flatten

flattenDeep

forEach

forEachRight

groupBy

includes

indexOf

initial

intersection

invokeMap

join

keyBy

last

lastIndexOf

map

mapKeys

method

orderBy

over

overEvery

overSome

property

pull

pullAt

reject

remove

reverse

shuffle

size

slice

some

sortBy

sortedIndex

sortedIndexBy

sortedIndexOf

sortedLastIndex

sortedLastIndexBy

sortedUniq

sortedUniqBy

sum

sumBy

tail

take

takeRight

takeRightWhile

takeWhile

toArray

union

unionBy

uniq

uniqBy

unzip

without

wrap

xor

zip

zipObject

LoDashExplicitObjectWrapper

LoDashExplicitObjectWrapper:

ary

  • see

    _.ary

    Type parameters

    • TResult: Function

    Parameters

    • Optional n: number

    Returns LoDashExplicitObjectWrapper<TResult>

assign

  • see

    _.assign

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    • source: TSource

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.assign

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.assign

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

assignIn

  • see

    _.assignIn

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    • source: TSource

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.assignIn

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.assignIn

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

assignInWith

  • see

    _.assignInWith

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.assignInWith

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.assignInWith

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

assignWith

  • see

    _.assignWith

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.assignWith

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.assignWith

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

at

  • see

    _.at

    Type parameters

    • T

    Parameters

    • Rest ...props: number | string | Array<number | string>

    Returns LoDashExplicitArrayWrapper<T>

attempt

  • see

    _.attempt

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<TResult | Error>

bind

  • see

    _.bind

    Type parameters

    • TResult: Function

    Parameters

    • thisArg: any
    • Rest ...partials: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

bindAll

  • see

    _.bindAll

    Parameters

    • Rest ...methodNames: string | Array<string>

    Returns LoDashExplicitObjectWrapper<T>

bindKey

  • see

    _.bindKey

    Type parameters

    • TResult: Function

    Parameters

    • key: any
    • Rest ...partials: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

chain

chunk

  • see

    _.chunk

    Type parameters

    • TResult

    Parameters

    • Optional size: number

    Returns LoDashExplicitArrayWrapper<TResult[]>

commit

compact

  • see

    _.compact

    Type parameters

    • TResult

    Returns LoDashExplicitArrayWrapper<TResult>

concat

constant

countBy

create

  • see

    _.create

    Type parameters

    • U: Object

    Parameters

    • Optional properties: U

    Returns LoDashExplicitObjectWrapper<T & U>

debounce

defaults

  • see

    _.defaults

    Type parameters

    • S1: object

    • TResult: object

    Parameters

    • source1: S1
    • Rest ...sources: object[]

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • Rest ...sources: object[]

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • S3: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • source3: S3
    • Rest ...sources: object[]

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • S3: object

    • S4: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • source3: S3
    • source4: S4
    • Rest ...sources: object[]

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.defaults

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.defaults

    Type parameters

    • TResult

    Parameters

    • Rest ...sources: object[]

    Returns LoDashExplicitObjectWrapper<TResult>

defer

  • see

    _.defer

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitWrapper<number>

delay

  • see

    _.delay

    Parameters

    • wait: number
    • Rest ...args: any[]

    Returns LoDashExplicitWrapper<number>

difference

  • see

    _.difference

    Type parameters

    • TValue

    Parameters

    • Rest ...values: Array<TValue> | List<TValue>

    Returns LoDashExplicitArrayWrapper<TValue>

differenceBy

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Rest ...values: any[]

    Returns LoDashExplicitArrayWrapper<T>

drop

  • see

    _.drop

    Type parameters

    • T

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<T>

dropRight

  • see

    _.dropRight

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<TResult>

dropRightWhile

  • see

    _.dropRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.dropRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.dropRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<TValue>

dropWhile

  • see

    _.dropWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.dropWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.dropWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<TValue>

each

eachRight

eq

every

  • see

    _.every

    Type parameters

    • TResult

    Parameters

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.every

    Parameters

    • Optional predicate: string | any[]

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.every

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns LoDashExplicitWrapper<boolean>

extend

  • see

    _.assign

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.assign

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.assign

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

fill

  • see

    _.fill

    Type parameters

    • T

    Parameters

    • value: T
    • Optional start: number
    • Optional end: number

    Returns LoDashExplicitObjectWrapper<List<T>>

filter

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • predicate: W

    Returns LoDashExplicitArrayWrapper<T>

findIndex

  • see

    _.findIndex

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitWrapper<number>

findKey

  • see

    _.findKey

    Type parameters

    • TValues

    Parameters

    Returns LoDashExplicitWrapper<string>

  • see

    _.findKey

    Parameters

    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<string>

  • see

    _.findKey

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<string>

  • see

    _.findKey

    Type parameters

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitWrapper<string>

findLastIndex

  • see

    _.findLastIndex

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findLastIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<number>

  • see

    _.findLastIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitWrapper<number>

findLastKey

  • see

    _.findLastKey

    Type parameters

    • TValues

    Parameters

    Returns LoDashExplicitWrapper<string>

  • see

    _.findLastKey

    Parameters

    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<string>

  • see

    _.findLastKey

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitWrapper<string>

  • see

    _.findLastKey

    Type parameters

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitWrapper<string>

flatten

  • see

    _.flatten

    Type parameters

    • TResult

    Parameters

    • Optional isDeep: boolean

    Returns LoDashExplicitArrayWrapper<TResult>

flattenDeep

  • see

    _.flattenDeep

    Type parameters

    • T

    Returns LoDashExplicitArrayWrapper<T>

flip

flow

  • see

    _.flow

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashExplicitObjectWrapper<TResult>

flowRight

  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashExplicitObjectWrapper<TResult>

forEach

forEachRight

forIn

forInRight

forOwn

forOwnRight

functions

functionsIn

groupBy

gt

gte

has

hasIn

includes

  • see

    _.includes

    Type parameters

    • TValue

    Parameters

    • target: TValue
    • Optional fromIndex: number

    Returns LoDashExplicitWrapper<boolean>

indexOf

  • see

    _.indexOf

    Type parameters

    • TValue

    Parameters

    • value: TValue
    • Optional fromIndex: boolean | number

    Returns LoDashExplicitWrapper<number>

initial

intersection

  • see

    _.intersection

    Type parameters

    • TResult

    Parameters

    • Rest ...arrays: Array<TResult> | List<TResult>

    Returns LoDashExplicitArrayWrapper<TResult>

invert

  • see

    _.invert

    Type parameters

    • TResult: object

    Parameters

    • Optional multiValue: boolean

    Returns LoDashExplicitObjectWrapper<TResult>

invokeMap

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns LoDashExplicitArrayWrapper<TResult>

isArguments

isArray

isArrayLike

isArrayLikeObject

isBoolean

isDate

isElement

isEmpty

isEqual

isEqualWith

isError

isFinite

isFunction

isInteger

isLength

isNaN

isNative

isNil

isNull

isNumber

isObject

isObjectLike

isPlainObject

isRegExp

isSafeInteger

isString

isSymbol

isTypedArray

isUndefined

iteratee

  • see

    _.iteratee

    Parameters

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<function>

  • see

    _.iteratee

    Type parameters

    • TResult

    Parameters

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<function>

join

  • see

    _.join

    Parameters

    • Optional separator: string

    Returns LoDashExplicitWrapper<string>

keyBy

keys

keysIn

last

lastIndexOf

  • see

    _.lastIndexOf

    Type parameters

    • TResult

    Parameters

    • value: TResult
    • Optional fromIndex: boolean | number

    Returns LoDashExplicitWrapper<number>

lt

lte

map

  • see

    _.map

    Type parameters

    • TValue

    • TResult

    Parameters

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TValue

    • TResult

    Parameters

    • Optional iteratee: string

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TObject: object

    Parameters

    • Optional iteratee: TObject

    Returns LoDashExplicitArrayWrapper<boolean>

mapKeys

matches

matchesProperty

merge

  • see

    _.merge

    Type parameters

    • TSource

    Parameters

    • source: TSource

    Returns LoDashExplicitObjectWrapper<T & TSource>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashExplicitObjectWrapper<T & TSource1 & TSource2>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashExplicitObjectWrapper<T & TSource1 & TSource2 & TSource3>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    • TSource4

    Returns LoDashExplicitObjectWrapper<T & TSource1 & TSource2 & TSource3 & TSource4>

  • see

    _.merge

    Type parameters

    • TResult

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashExplicitObjectWrapper<TResult>

methodOf

  • see

    _.methodOf

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<function>

mixin

negate

noop

now

omit

omitBy

once

orderBy

over

  • see

    _.over

    Type parameters

    • TResult

    Parameters

    • Rest ...iteratees: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

overArgs

  • see

    _.overArgs

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...transforms: Function[]

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.overArgs

    Type parameters

    • TResult: Function

    Parameters

    • transforms: Function[]

    Returns LoDashExplicitObjectWrapper<TResult>

overEvery

  • see

    _.overEvery

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

overSome

  • see

    _.overSome

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashExplicitObjectWrapper<function>

pick

pickBy

plant

propertyOf

pull

  • see

    _.pull

    Type parameters

    • TValue

    Parameters

    • Rest ...values: TValue[]

    Returns LoDashExplicitObjectWrapper<List<TValue>>

pullAt

  • see

    _.pullAt

    Type parameters

    • T

    Parameters

    • Rest ...indexes: number | Array<number>

    Returns LoDashExplicitArrayWrapper<T>

reject

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • W

    • T

    Parameters

    • predicate: W

    Returns LoDashExplicitArrayWrapper<T>

remove

  • see

    _.remove

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.remove

    Type parameters

    • TResult

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.remove

    Type parameters

    • W

    • TResult

    Parameters

    • Optional predicate: W

    Returns LoDashExplicitArrayWrapper<TResult>

replace

  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns LoDashExplicitWrapper<string>

  • see

    _.replace

    Parameters

    • Optional replacement: Function | string

    Returns LoDashExplicitWrapper<string>

rest

  • see

    _.rest

    Type parameters

    • TResult: Function

    Parameters

    • Optional start: number

    Returns LoDashExplicitObjectWrapper<TResult>

set

setWith

shuffle

size

  • see

    _.size

    Returns LoDashExplicitWrapper<number>

some

  • see

    _.some

    Type parameters

    • TResult

    Parameters

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.some

    Parameters

    • Optional predicate: string | any[]

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.some

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns LoDashExplicitWrapper<boolean>

sortBy

sortedIndex

  • see

    _.sortedIndex

    Type parameters

    • T

    • TSort

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndex

    Type parameters

    • W

    • T

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

sortedIndexBy

  • see

    _.sortedIndexBy

    Type parameters

    • T

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: string

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Type parameters

    • W

    • T

    Parameters

    • value: T
    • iteratee: W

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: Object

    Returns LoDashExplicitWrapper<number>

sortedIndexOf

  • see

    _.sortedIndexOf

    Type parameters

    • TValue

    Parameters

    • value: TValue

    Returns LoDashExplicitWrapper<number>

sortedLastIndex

  • see

    _.sortedLastIndex

    Type parameters

    • T

    • TSort

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndex

    Type parameters

    • T

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndex

    Type parameters

    • W

    • T

    Parameters

    • value: T

    Returns LoDashExplicitWrapper<number>

sortedLastIndexBy

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: string

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    • T

    Parameters

    • value: T
    • iteratee: W

    Returns LoDashExplicitWrapper<number>

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: Object

    Returns LoDashExplicitWrapper<number>

sortedUniq

  • see

    _.sortedUniq

    Type parameters

    • T

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniq

    Type parameters

    • T

    • TSort

    Returns LoDashExplicitArrayWrapper<T>

sortedUniqBy

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • iteratee: string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • iteratee: Object

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • iteratee: TWhere

    Returns LoDashExplicitArrayWrapper<T>

spread

  • see

    _.spread

    Type parameters

    • T: Function

    Returns LoDashExplicitObjectWrapper<T>

sum

  • see

    _.sum

    Type parameters

    • TValue

    Returns LoDashExplicitWrapper<number>

  • see

    _.sum

    Returns LoDashExplicitWrapper<number>

sumBy

tail

take

  • see

    _.take

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<TResult>

takeRight

  • see

    _.takeRight

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashExplicitArrayWrapper<TResult>

takeRightWhile

  • see

    _.takeRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.takeRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.takeRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<TValue>

takeWhile

  • see

    _.takeWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.takeWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TValue>

  • see

    _.takeWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashExplicitArrayWrapper<TValue>

tap

throttle

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

toArray

  • see

    _.toArray

    Type parameters

    • TResult

    Returns LoDashExplicitArrayWrapper<TResult>

toInteger

toLength

toNumber

toPairs

  • see

    _.toPairs

    Type parameters

    • TResult

    Returns LoDashExplicitArrayWrapper<TResult[]>

toPairsIn

  • see

    _.toPairsIn

    Type parameters

    • TResult

    Returns LoDashExplicitArrayWrapper<TResult[]>

toPath

toSafeInteger

unary

union

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T>

unionBy

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Rest ...iteratee: any[]

    Returns LoDashExplicitArrayWrapper<T>

uniq

uniqBy

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • iteratee: string

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • iteratee: Object

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • iteratee: TWhere

    Returns LoDashExplicitArrayWrapper<T>

unset

unzip

values

valuesIn

without

  • see

    _.without

    Type parameters

    • T

    Parameters

    • Rest ...values: T[]

    Returns LoDashExplicitArrayWrapper<T>

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashExplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashExplicitObjectWrapper<R>

xor

  • see

    _.xor

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T>

zip

  • see

    _.zip

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashExplicitArrayWrapper<T[]>

zipObject

  • see

    _.zipObject

    Type parameters

    • TValues

    • TResult: object

    Parameters

    • Optional values: List<TValues>

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    • Optional values: List<any>

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Parameters

    • Optional values: List<any>

    Returns LoDashExplicitObjectWrapper<Dictionary<any>>

LoDashExplicitStringWrapper

LoDashExplicitStringWrapper:

add

after

before

camelCase

capitalize

ceil

clamp

countBy

deburr

each

eachRight

endsWith

escape

escapeRegExp

filter

flatten

flattenDeep

floor

forEach

forEachRight

groupBy

inRange

includes

iteratee

join

kebabCase

keyBy

lowerCase

lowerFirst

method

nthArg

orderBy

pad

padEnd

padStart

parseInt

property

random

range

rangeRight

reject

repeat

replace

round

shuffle

size

snakeCase

sortedIndex

sortedIndexBy

  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns LoDashExplicitWrapper<number>

sortedLastIndex

sortedLastIndexBy

sortedUniq

sortedUniqBy

split

startCase

startsWith

subtract

template

times

toArray

toLower

toUpper

trim

trimEnd

trimStart

truncate

unescape

uniq

uniqBy

uniqueId

upperCase

upperFirst

words

wrap

LoDashExplicitWrapper

LoDashExplicitWrapper:

add

  • see

    _.add

    Parameters

    • addend: number

    Returns LoDashExplicitWrapper<number>

after

  • see

    _.after

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns LoDashExplicitObjectWrapper<TFunc>

before

  • see

    _.before

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns LoDashExplicitObjectWrapper<TFunc>

camelCase

  • see

    _.camelCase

    Returns LoDashExplicitWrapper<string>

capitalize

  • see

    _.capitalize

    Returns LoDashExplicitWrapper<string>

ceil

  • see

    _.ceil

    Parameters

    • Optional precision: number

    Returns LoDashExplicitWrapper<number>

chain

clamp

  • see

    _.clamp

    Parameters

    • lower: number
    • upper: number

    Returns LoDashExplicitWrapper<number>

commit

concat

constant

countBy

deburr

  • see

    _.deburr

    Returns LoDashExplicitWrapper<string>

each

  • see

    _.forEach

    Parameters

    Returns LoDashExplicitWrapper<string>

eachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashExplicitWrapper<string>

endsWith

  • see

    _.endsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns LoDashExplicitWrapper<boolean>

eq

escape

  • see

    _.escape

    Returns LoDashExplicitWrapper<string>

escapeRegExp

  • see

    _.escapeRegExp

    Returns LoDashExplicitWrapper<string>

filter

flatten

flattenDeep

floor

  • see

    _.floor

    Parameters

    • Optional precision: number

    Returns LoDashExplicitWrapper<number>

forEach

  • see

    _.forEach

    Parameters

    Returns LoDashExplicitWrapper<string>

forEachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashExplicitWrapper<string>

groupBy

gt

gte

inRange

  • see

    _.inRange

    Parameters

    • start: number
    • end: number

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.inRange

    Parameters

    • end: number

    Returns LoDashExplicitWrapper<boolean>

includes

  • see

    _.includes

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns LoDashExplicitWrapper<boolean>

isArguments

isArray

isArrayLike

isArrayLikeObject

isBoolean

isDate

isElement

isEmpty

isEqual

isEqualWith

isError

isFinite

isFunction

isInteger

isLength

isNaN

isNative

isNil

isNull

isNumber

isObject

isObjectLike

isPlainObject

isRegExp

isSafeInteger

isString

isSymbol

isTypedArray

isUndefined

iteratee

  • see

    _.iteratee

    Type parameters

    • TResult

    Parameters

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<function>

join

  • see

    _.join

    Parameters

    • Optional separator: string

    Returns LoDashExplicitWrapper<string>

kebabCase

  • see

    _.kebabCase

    Returns LoDashExplicitWrapper<string>

keyBy

lowerCase

  • see

    _.lowerCase

    Returns LoDashExplicitWrapper<string>

lowerFirst

  • see

    _.lowerFirst

    Returns LoDashExplicitWrapper<string>

lt

lte

matches

matchesProperty

method

  • see

    _.method

    Type parameters

    • TObject

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitObjectWrapper<function>

noop

now

nthArg

  • see

    _.nthArg

    Type parameters

    • TResult: Function

    Returns LoDashExplicitObjectWrapper<TResult>

orderBy

pad

  • see

    _.pad

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

padEnd

  • see

    _.padEnd

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

padStart

  • see

    _.padStart

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

parseInt

  • see

    _.parseInt

    Parameters

    • Optional radix: number

    Returns LoDashExplicitWrapper<number>

plant

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashExplicitObjectWrapper<function>

random

  • see

    _.random

    Parameters

    • Optional max: number
    • Optional floating: boolean

    Returns LoDashExplicitWrapper<number>

  • see

    _.random

    Parameters

    • Optional floating: boolean

    Returns LoDashExplicitWrapper<number>

range

  • see

    _.range

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashExplicitArrayWrapper<number>

rangeRight

  • see

    _.rangeRight

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashExplicitArrayWrapper<number>

reject

repeat

  • see

    _.repeat

    Parameters

    • Optional n: number

    Returns LoDashExplicitWrapper<string>

replace

  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns LoDashExplicitWrapper<string>

  • see

    _.replace

    Parameters

    • Optional replacement: Function | string

    Returns LoDashExplicitWrapper<string>

round

  • see

    _.round

    Parameters

    • Optional precision: number

    Returns LoDashExplicitWrapper<number>

shuffle

size

  • see

    _.size

    Returns LoDashExplicitWrapper<number>

snakeCase

  • see

    _.snakeCase

    Returns LoDashExplicitWrapper<string>

sortedIndex

  • see

    _.sortedIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns LoDashExplicitWrapper<number>

sortedIndexBy

  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns LoDashExplicitWrapper<number>

sortedLastIndex

  • see

    _.sortedLastIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns LoDashExplicitWrapper<number>

sortedLastIndexBy

  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns LoDashExplicitWrapper<number>

sortedUniq

  • see

    _.sortedUniq

    Type parameters

    • TSort

    Returns LoDashExplicitArrayWrapper<T>

sortedUniqBy

split

  • see

    _.split

    Parameters

    • Optional separator: RegExp | string
    • Optional limit: number

    Returns LoDashExplicitArrayWrapper<string>

startCase

  • see

    _.startCase

    Returns LoDashExplicitWrapper<string>

startsWith

  • see

    _.startsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns LoDashExplicitWrapper<boolean>

subtract

  • see

    _.subtract

    Parameters

    • subtrahend: number

    Returns LoDashExplicitWrapper<number>

tap

  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<T>

template

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

times

  • see

    _.times

    Type parameters

    • TResult

    Parameters

    • iteratee: function
        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    Returns LoDashExplicitArrayWrapper<TResult>

  • see

    _.times

    Returns LoDashExplicitArrayWrapper<number>

toArray

  • see

    _.toArray

    Type parameters

    • TResult

    Returns LoDashExplicitArrayWrapper<TResult>

toInteger

toLength

toLower

  • see

    _.toLower

    Returns LoDashExplicitWrapper<string>

toNumber

toPath

toSafeInteger

toUpper

  • see

    _.toUpper

    Returns LoDashExplicitWrapper<string>

trim

  • see

    _.trim

    Parameters

    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

trimEnd

  • see

    _.trimEnd

    Parameters

    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

trimStart

  • see

    _.trimStart

    Parameters

    • Optional chars: string

    Returns LoDashExplicitWrapper<string>

truncate

unescape

  • see

    _.unescape

    Returns LoDashExplicitWrapper<string>

uniq

uniqBy

uniqueId

  • see

    _.uniqueId

    Returns LoDashExplicitWrapper<string>

upperCase

  • see

    _.upperCase

    Returns LoDashExplicitWrapper<string>

upperFirst

  • see

    _.upperFirst

    Returns LoDashExplicitWrapper<string>

words

  • see

    _.words

    Parameters

    • Optional pattern: string | RegExp

    Returns LoDashExplicitArrayWrapper<string>

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashExplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashExplicitObjectWrapper<R>

LoDashExplicitWrapperBase

LoDashExplicitWrapperBase:

chain

  • chain(): TWrapper
  • see

    _.chain

    Returns TWrapper

commit

  • commit(): TWrapper
  • see

    _.commit

    Returns TWrapper

concat

  • see

    _.concat

    Type parameters

    • TItem

    Parameters

    • Rest ...items: Array<TItem | Array<TItem>>

    Returns LoDashExplicitArrayWrapper<TItem>

  • see

    _.concat

    Parameters

    • Rest ...items: Array<T | Array<T>>

    Returns LoDashExplicitArrayWrapper<T>

constant

  • see

    _.constant

    Type parameters

    • TResult

    Returns LoDashExplicitObjectWrapper<function>

eq

  • see

    _.isEqual

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

gt

  • see

    _.gt

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

gte

  • see

    _.gte

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

isArguments

  • see

    _.isArguments

    Returns LoDashExplicitWrapper<boolean>

isArray

  • see

    _.isArray

    Returns LoDashExplicitWrapper<boolean>

isArrayLike

  • see

    _.isArrayLike

    Returns LoDashExplicitWrapper<boolean>

isArrayLikeObject

  • see

    _.isArrayLikeObject

    Returns LoDashExplicitWrapper<boolean>

isBoolean

  • see

    _.isBoolean

    Returns LoDashExplicitWrapper<boolean>

isDate

  • see

    _.isDate

    Returns LoDashExplicitWrapper<boolean>

isElement

  • see

    _.isElement

    Returns LoDashExplicitWrapper<boolean>

isEmpty

  • see

    _.isEmpty

    Returns LoDashExplicitWrapper<boolean>

isEqual

  • see

    _.isEqual

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

isEqualWith

isError

  • see

    _.isError

    Returns LoDashExplicitWrapper<boolean>

isFinite

  • see

    _.isFinite

    Returns LoDashExplicitWrapper<boolean>

isFunction

  • see

    _.isFunction

    Returns LoDashExplicitWrapper<boolean>

isInteger

  • see

    _.isInteger

    Returns LoDashExplicitWrapper<boolean>

isLength

  • see

    _.isLength

    Returns LoDashExplicitWrapper<boolean>

isNaN

  • see

    _.isNaN

    Returns LoDashExplicitWrapper<boolean>

isNative

  • see _.isNative

    Returns LoDashExplicitWrapper<boolean>

isNil

  • see _.isNil

    Returns LoDashExplicitWrapper<boolean>

isNull

  • see _.isNull

    Returns LoDashExplicitWrapper<boolean>

isNumber

  • see _.isNumber

    Returns LoDashExplicitWrapper<boolean>

isObject

  • see _.isObject

    Returns LoDashExplicitWrapper<boolean>

isObjectLike

  • see _.isObjectLike

    Returns LoDashExplicitWrapper<boolean>

isPlainObject

  • see _.isPlainObject

    Returns LoDashExplicitWrapper<boolean>

isRegExp

  • see _.isRegExp

    Returns LoDashExplicitWrapper<boolean>

isSafeInteger

  • see _.isSafeInteger

    Returns LoDashExplicitWrapper<boolean>

isString

  • see _.isString

    Returns LoDashExplicitWrapper<boolean>

isSymbol

  • see _.isSymbol

    Returns LoDashExplicitWrapper<boolean>

isTypedArray

  • see _.isTypedArray

    Returns LoDashExplicitWrapper<boolean>

isUndefined

  • see _.isUndefined

    Returns LoDashExplicitWrapper<boolean>

lt

  • see

    _.lt

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

lte

  • see

    _.lte

    Parameters

    • other: any

    Returns LoDashExplicitWrapper<boolean>

matches

  • see

    _.matches

    Type parameters

    • V

    Returns LoDashExplicitObjectWrapper<function>

matchesProperty

  • see

    _.matchesProperty

    Type parameters

    • SrcValue

    Parameters

    • srcValue: SrcValue

    Returns LoDashExplicitObjectWrapper<function>

  • see

    _.matchesProperty

    Type parameters

    • SrcValue

    • Value

    Parameters

    • srcValue: SrcValue

    Returns LoDashExplicitObjectWrapper<function>

noop

  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns LoDashExplicitWrapper<void>

now

plant

  • see

    _.plant

    Parameters

    • value: number

    Returns LoDashExplicitWrapper<number>

  • see

    _.plant

    Parameters

    • value: string

    Returns LoDashExplicitStringWrapper

  • see

    _.plant

    Parameters

    • value: boolean

    Returns LoDashExplicitWrapper<boolean>

  • see

    _.plant

    Parameters

    • value: number[]

    Returns LoDashExplicitNumberArrayWrapper

  • see

    _.plant

    Type parameters

    • T

    Parameters

    • value: T[]

    Returns LoDashExplicitArrayWrapper<T>

  • see

    _.plant

    Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashExplicitObjectWrapper<T>

  • see

    _.plant

    Parameters

    • value: any

    Returns LoDashExplicitWrapper<any>

tap

  • tap(interceptor: function, thisArg?: any): TWrapper
  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • Optional thisArg: any

    Returns TWrapper

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashExplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashExplicitArrayWrapper<TResult>

toInteger

  • see

    _.toInteger

    Returns LoDashExplicitWrapper<number>

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toLength

  • see

    _.toLength

    Returns LoDashExplicitWrapper<number>

toNumber

  • see

    _.toNumber

    Returns LoDashExplicitWrapper<number>

toPath

  • see

    _.toPath

    Returns LoDashExplicitWrapper<string[]>

toSafeInteger

  • see

    _.toSafeInteger

    Returns LoDashExplicitWrapper<number>

toString

  • toString(): string
  • Produces the result of coercing the unwrapped value to a string.

    Returns string

    Returns the coerced string value.

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    alias

    .toJSON, .valueOf

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T

LoDashImplicitArrayWrapper

LoDashImplicitArrayWrapper:

at

  • see

    _.at

    Parameters

    • Rest ...props: number | string | Array<number | string>

    Returns LoDashImplicitArrayWrapper<T>

chain

chunk

  • see

    _.chunk

    Parameters

    • Optional size: number

    Returns LoDashImplicitArrayWrapper<T[]>

clone

  • clone(): T[]
  • clone(customizer: function): T[]
  • see

    _.clone

    Returns T[]

  • see

    _.clone

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T[]

cloneDeep

  • cloneDeep(): T[]
  • cloneDeep(customizer: function): T[]
  • see

    _.cloneDeep

    Returns T[]

  • see

    _.cloneDeep

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T[]

commit

compact

concat

constant

countBy

difference

  • see

    _.difference

    Parameters

    • Rest ...values: Array<T> | List<T>

    Returns LoDashImplicitArrayWrapper<T>

differenceBy

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Rest ...values: any[]

    Returns LoDashImplicitArrayWrapper<T>

drop

  • see

    _.drop

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<T>

dropRight

  • see

    _.dropRight

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<T>

dropRightWhile

  • see

    _.dropRightWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.dropRightWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.dropRightWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<T>

dropWhile

  • see

    _.dropWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.dropWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.dropWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<T>

each

eachRight

eq

  • eq(other: any): boolean
  • see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

every

  • see

    _.every

    Parameters

    Returns boolean

  • see

    _.every

    Parameters

    • Optional predicate: string | any[]

    Returns boolean

  • see

    _.every

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns boolean

fill

  • see

    _.fill

    Type parameters

    • T

    Parameters

    • value: T
    • Optional start: number
    • Optional end: number

    Returns LoDashImplicitArrayWrapper<T>

filter

  • see

    _.filter

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.filter

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    Parameters

    • predicate: W

    Returns LoDashImplicitArrayWrapper<T>

find

  • find(predicate?: ListIterator<T, boolean>, thisArg?: any): T
  • find(predicate?: string, thisArg?: any): T
  • find<TObject>(predicate?: TObject): T
  • see

    _.find

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T

  • see

    _.find

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns T

  • see

    _.find

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns T

findIndex

  • findIndex(predicate?: ListIterator<T, boolean>, thisArg?: any): number
  • findIndex(predicate?: string, thisArg?: any): number
  • findIndex<W>(predicate?: W): number
  • see

    _.findIndex

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns number

findLast

  • findLast(callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<W>(whereValue: W): T
  • findLast(pluckValue: string): T
  • see

    _.findLast

    Parameters

    Returns T

  • see

    _.findLast

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns T

  • see

    _.findLast

    Parameters

    • pluckValue: string

    Returns T

findLastIndex

  • findLastIndex(predicate?: ListIterator<T, boolean>, thisArg?: any): number
  • findLastIndex(predicate?: string, thisArg?: any): number
  • findLastIndex<W>(predicate?: W): number
  • see

    _.findLastIndex

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findLastIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns number

first

  • first(): T
  • see

    _.head

    Returns T

flatten

  • see

    _.flatten

    Type parameters

    • TResult

    Parameters

    • Optional isDeep: boolean

    Returns LoDashImplicitArrayWrapper<TResult>

flattenDeep

  • see

    _.flattenDeep

    Type parameters

    • T

    Returns LoDashImplicitArrayWrapper<T>

forEach

forEachRight

groupBy

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

head

  • head(): T
  • see

    _.first

    Returns T

identity

  • identity(): T[]
  • see

    _.identity

    Returns T[]

includes

  • includes(target: T, fromIndex?: number): boolean
  • see

    _.includes

    Parameters

    • target: T
    • Optional fromIndex: number

    Returns boolean

indexOf

  • indexOf(value: T, fromIndex?: boolean | number): number
  • see

    _.indexOf

    Parameters

    • value: T
    • Optional fromIndex: boolean | number

    Returns number

initial

intersection

  • see

    _.intersection

    Type parameters

    • TResult

    Parameters

    • Rest ...arrays: Array<TResult> | List<TResult>

    Returns LoDashImplicitArrayWrapper<TResult>

invokeMap

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns LoDashImplicitArrayWrapper<TResult>

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean

isArrayLike

  • isArrayLike(): boolean

isArrayLikeObject

  • isArrayLikeObject(): boolean

isBoolean

  • isBoolean(): boolean

isDate

  • isDate(): boolean

isElement

  • isElement(): boolean

isEmpty

  • isEmpty(): boolean

isEqual

  • isEqual(other: any): boolean

isEqualWith

isError

  • isError(): boolean

isFinite

  • isFinite(): boolean

isFunction

  • isFunction(): boolean

isInteger

  • isInteger(): boolean

isLength

  • isLength(): boolean

isNaN

  • isNaN(): boolean

isNative

  • isNative(): boolean

isNil

  • isNil(): boolean

isNull

  • isNull(): boolean

isNumber

  • isNumber(): boolean

isObject

  • isObject(): boolean

isObjectLike

  • isObjectLike(): boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean

isSafeInteger

  • isSafeInteger(): boolean

isString

  • isString(): boolean

isSymbol

  • isSymbol(): boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

join

  • join(separator?: string): string
  • see

    _.join

    Parameters

    • Optional separator: string

    Returns string

keyBy

last

  • last(): T
  • see

    _.last

    Returns T

lastIndexOf

  • lastIndexOf(value: T, fromIndex?: boolean | number): number
  • see

    _.lastIndexOf

    Parameters

    • value: T
    • Optional fromIndex: boolean | number

    Returns number

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

map

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • Optional iteratee: ListIterator<T, TResult>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • Optional iteratee: string

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TObject: object

    Parameters

    • Optional iteratee: TObject

    Returns LoDashImplicitArrayWrapper<boolean>

mapKeys

matches

matchesProperty

max

  • max(): T
  • see

    _.max

    Returns T

maxBy

  • maxBy(iteratee?: ListIterator<T, any>): T
  • maxBy(iteratee?: string): T
  • maxBy<TObject>(whereValue?: TObject): T
  • see

    _.maxBy

    Parameters

    Returns T

  • see

    _.maxBy

    Parameters

    • Optional iteratee: string

    Returns T

  • see

    _.maxBy

    Type parameters

    • TObject: object

    Parameters

    • Optional whereValue: TObject

    Returns T

mean

  • mean<T>(): number
  • mean(): number
  • see

    _.mean

    Type parameters

    • T

    Returns number

  • see

    _.mean

    Returns number

method

  • see

    _.method

    Type parameters

    • TObject

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitObjectWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitObjectWrapper<function>

min

  • min(): T
  • see

    _.min

    Returns T

minBy

  • minBy(iteratee?: ListIterator<T, any>): T
  • minBy(iteratee?: string): T
  • minBy<TObject>(whereValue?: TObject): T
  • see

    _.minBy

    Parameters

    Returns T

  • see

    _.minBy

    Parameters

    • Optional iteratee: string

    Returns T

  • see

    _.minBy

    Type parameters

    • TObject: object

    Parameters

    • Optional whereValue: TObject

    Returns T

noConflict

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

now

  • now(): number

orderBy

  • see

    _.orderBy

    Type parameters

    • W: Object

    Parameters

    • iteratees: ListIterator<T, any> | string | W | ListIterator<T, any> | string | W
    • Optional orders: boolean | string | boolean | string

    Returns LoDashImplicitArrayWrapper<T>

over

  • see

    _.over

    Type parameters

    • TResult

    Parameters

    • Rest ...iteratees: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

overEvery

  • see

    _.overEvery

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

overSome

  • see

    _.overSome

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

partition

  • see

    _.partition

    Parameters

    Returns LoDashImplicitArrayWrapper<T[]>

  • see

    _.partition

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns LoDashImplicitArrayWrapper<T[]>

  • see

    _.partition

    Parameters

    • path: string
    • srcValue: any

    Returns LoDashImplicitArrayWrapper<T[]>

  • see

    _.partition

    Parameters

    • pluckValue: string

    Returns LoDashImplicitArrayWrapper<T[]>

plant

pop

  • pop(): T
  • Returns T

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashImplicitObjectWrapper<function>

pull

  • see

    _.pull

    Parameters

    • Rest ...values: T[]

    Returns LoDashImplicitArrayWrapper<T>

pullAt

  • see

    _.pullAt

    Parameters

    • Rest ...indexes: number | Array<number>

    Returns LoDashImplicitArrayWrapper<T>

push

reduce

  • reduce<TResult>(callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TResult>(callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    Returns TResult

reject

  • see

    _.reject

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.reject

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • W

    Parameters

    • predicate: W

    Returns LoDashImplicitArrayWrapper<T>

remove

  • see

    _.remove

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.remove

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.remove

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns LoDashImplicitArrayWrapper<T>

result

  • result<TResult>(path: number | string | boolean | Array<number | string | boolean>, defaultValue?: TResult): TResult
  • see

    _.result

    Type parameters

    • TResult

    Parameters

    • path: number | string | boolean | Array<number | string | boolean>
    • Optional defaultValue: TResult

    Returns TResult

reverse

  • Reverses the wrapped array so the first element becomes the last, the second element becomes the second to last, and so on.

    Note: This method mutates the wrapped array.

    Returns LoDashImplicitArrayWrapper<T>

    Returns the new reversed lodash wrapper instance.

sample

sampleSize

  • see

    _.sampleSize

    Parameters

    • n: number

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sampleSize

    Returns LoDashImplicitWrapper<T>

shift

  • shift(): T
  • Returns T

shuffle

size

  • size(): number
  • see

    _.size

    Returns number

slice

  • see

    _.slice

    Parameters

    • Optional start: number
    • Optional end: number

    Returns LoDashImplicitArrayWrapper<T>

some

  • see

    _.some

    Parameters

    Returns boolean

  • see

    _.some

    Parameters

    • Optional predicate: string | any[]

    Returns boolean

  • see

    _.some

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns boolean

sort

  • Parameters

    • Optional compareFn: function
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns LoDashImplicitArrayWrapper<T>

sortBy

sortedIndex

  • sortedIndex<TSort>(value: T): number
  • sortedIndex(value: T): number
  • see

    _.sortedIndex

    Type parameters

    • TSort

    Parameters

    • value: T

    Returns number

  • see

    _.sortedIndex

    Parameters

    • value: T

    Returns number

sortedIndexBy

  • sortedIndexBy<TSort>(value: T, iteratee: function): number
  • sortedIndexBy(value: T, iteratee: string): number
  • sortedIndexBy<W>(value: T, iteratee: W): number
  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

  • see

    _.sortedIndexBy

    Parameters

    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • W

    Parameters

    • value: T
    • iteratee: W

    Returns number

sortedIndexOf

  • sortedIndexOf(value: T): number
  • see

    _.sortedIndexOf

    Parameters

    • value: T

    Returns number

sortedLastIndex

  • sortedLastIndex<TSort>(value: T): number
  • sortedLastIndex(value: T): number
  • sortedLastIndex<W>(value: T): number
  • see

    _.sortedLastIndex

    Type parameters

    • TSort

    Parameters

    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Parameters

    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • W

    Parameters

    • value: T

    Returns number

sortedLastIndexBy

  • sortedLastIndexBy<TSort>(value: T, iteratee: function): number
  • sortedLastIndexBy(value: T, iteratee: string): number
  • sortedLastIndexBy<W>(value: T, iteratee: W): number
  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

  • see

    _.sortedLastIndexBy

    Parameters

    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    Parameters

    • value: T
    • iteratee: W

    Returns number

sortedUniq

sortedUniqBy

  • see

    _.sortedUniqBy

    Type parameters

    • TSort

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Parameters

    • iteratee: string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • TWhere: object

    Parameters

    • iteratee: TWhere

    Returns LoDashImplicitArrayWrapper<T>

splice

  • Parameters

    • start: number

    Returns LoDashImplicitArrayWrapper<T>

  • Parameters

    • start: number
    • deleteCount: number
    • Rest ...items: any[]

    Returns LoDashImplicitArrayWrapper<T>

sum

  • sum(): number
  • see

    _.sum

    Returns number

sumBy

  • sumBy(iteratee: ListIterator<T, number>): number
  • sumBy(iteratee: string): number
  • sumBy(): number
  • see

    _.sumBy

    Parameters

    Returns number

  • see

    _.sumBy

    Parameters

    • iteratee: string

    Returns number

  • see

    _.sumBy

    Returns number

tail

take

  • see

    _.take

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<T>

takeRight

  • see

    _.takeRight

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<T>

takeRightWhile

  • see

    _.takeRightWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.takeRightWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.takeRightWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<T>

takeWhile

  • see

    _.takeWhile

    Parameters

    • Optional predicate: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.takeWhile

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.takeWhile

    Type parameters

    • TWhere

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<T>

tap

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T[]): TResult
        • Parameters

          • value: T[]

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T[]): TResult[]
        • Parameters

          • value: T[]

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

toArray

toInteger

toLength

toNumber

toPath

toPlainObject

toSafeInteger

transform

union

  • see

    _.union

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T>

unionBy

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Rest ...iteratee: any[]

    Returns LoDashImplicitArrayWrapper<T>

uniq

uniqBy

  • see

    _.uniqBy

    Type parameters

    • TSort

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Parameters

    • iteratee: string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • TWhere: object

    Parameters

    • iteratee: TWhere

    Returns LoDashImplicitArrayWrapper<T>

unshift

unzip

unzipWith

  • see

    _.unzipWith

    Type parameters

    • TArr

    • TResult

    Parameters

    • Optional iteratee: MemoIterator<TArr, TResult>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

without

  • see

    _.without

    Parameters

    • Rest ...values: T[]

    Returns LoDashImplicitArrayWrapper<T>

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashImplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashImplicitObjectWrapper<R>

xor

zip

  • see

    _.zip

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T[]>

zipObject

  • see

    _.zipObject

    Type parameters

    • TValues

    • TResult: object

    Parameters

    • Optional values: List<TValues>

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    • Optional values: List<any>

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Parameters

    • Optional values: List<any>

    Returns LoDashImplicitObjectWrapper<Dictionary<any>>

zipWith

  • see

    _.zipWith

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitArrayWrapper<TResult>

LoDashImplicitNumberArrayWrapper

LoDashImplicitNumberArrayWrapper:

at

chain

chunk

clone

  • clone(): number[]

cloneDeep

  • cloneDeep(): number[]

compact

countBy

difference

differenceBy

drop

dropRight

dropRightWhile

dropWhile

each

eachRight

every

  • every(predicate?: ListIterator<number, boolean> | NumericDictionaryIterator<number, boolean>): boolean
  • every(predicate?: string | any[]): boolean
  • every<TObject>(predicate?: TObject): boolean

fill

filter

find

  • find(predicate?: ListIterator<number, boolean>, thisArg?: any): number
  • find(predicate?: string, thisArg?: any): number
  • find<TObject>(predicate?: TObject): number
  • see

    _.find

    Parameters

    • Optional predicate: ListIterator<number, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.find

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.find

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns number

findIndex

  • findIndex(predicate?: ListIterator<number, boolean>, thisArg?: any): number
  • findIndex(predicate?: string, thisArg?: any): number
  • findIndex<W>(predicate?: W): number
  • see

    _.findIndex

    Parameters

    • Optional predicate: ListIterator<number, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns number

findLast

  • findLast(callback: ListIterator<number, boolean>, thisArg?: any): number
  • findLast<W>(whereValue: W): number
  • findLast(pluckValue: string): number

findLastIndex

  • findLastIndex(predicate?: ListIterator<number, boolean>, thisArg?: any): number
  • findLastIndex(predicate?: string, thisArg?: any): number
  • findLastIndex<W>(predicate?: W): number

first

  • first(): number

flatten

flattenDeep

forEach

forEachRight

groupBy

head

  • head(): number

identity

  • identity(): number[]

includes

  • includes(target: number, fromIndex?: number): boolean
  • see

    _.includes

    Parameters

    • target: number
    • Optional fromIndex: number

    Returns boolean

indexOf

  • indexOf(value: number, fromIndex?: boolean | number): number
  • see

    _.indexOf

    Parameters

    • value: number
    • Optional fromIndex: boolean | number

    Returns number

initial

intersection

invokeMap

join

  • join(separator?: string): string
  • see

    _.join

    Parameters

    • Optional separator: string

    Returns string

keyBy

last

  • last(): number

lastIndexOf

  • lastIndexOf(value: number, fromIndex?: boolean | number): number
  • see

    _.lastIndexOf

    Parameters

    • value: number
    • Optional fromIndex: boolean | number

    Returns number

map

mapKeys

max

  • max(): number

maxBy

  • maxBy(iteratee?: ListIterator<number, any>): number
  • maxBy(iteratee?: string): number
  • maxBy<TObject>(whereValue?: TObject): number
  • see

    _.maxBy

    Parameters

    Returns number

  • see

    _.maxBy

    Parameters

    • Optional iteratee: string

    Returns number

  • see

    _.maxBy

    Type parameters

    • TObject: object

    Parameters

    • Optional whereValue: TObject

    Returns number

mean

  • mean<T>(): number
  • mean(): number

method

min

  • min(): number

minBy

  • minBy(iteratee?: ListIterator<number, any>): number
  • minBy(iteratee?: string): number
  • minBy<TObject>(whereValue?: TObject): number
  • see

    _.minBy

    Parameters

    Returns number

  • see

    _.minBy

    Parameters

    • Optional iteratee: string

    Returns number

  • see

    _.minBy

    Type parameters

    • TObject: object

    Parameters

    • Optional whereValue: TObject

    Returns number

orderBy

over

overEvery

overSome

partition

pop

  • pop(): number

property

pull

pullAt

push

reduce

  • reduce<TResult>(callback: MemoIterator<number, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TResult>(callback: MemoIterator<number, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • Optional thisArg: any

    Returns TResult

reject

remove

reverse

  • Reverses the wrapped array so the first element becomes the last, the second element becomes the second to last, and so on.

    Note: This method mutates the wrapped array.

    Returns LoDashImplicitArrayWrapper<number>

    Returns the new reversed lodash wrapper instance.

sample

sampleSize

shift

  • shift(): number

shuffle

size

  • size(): number

slice

some

  • some(predicate?: ListIterator<number, boolean> | NumericDictionaryIterator<number, boolean>): boolean
  • some(predicate?: string | any[]): boolean
  • some<TObject>(predicate?: TObject): boolean

sort

sortBy

sortedIndex

  • sortedIndex<TSort>(value: number): number
  • sortedIndex(value: number): number

sortedIndexBy

  • sortedIndexBy<TSort>(value: number, iteratee: function): number
  • sortedIndexBy(value: number, iteratee: string): number
  • sortedIndexBy<W>(value: number, iteratee: W): number
  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: number
    • iteratee: function
        • (x: number): TSort
        • Parameters

          • x: number

          Returns TSort

    Returns number

  • see

    _.sortedIndexBy

    Parameters

    • value: number
    • iteratee: string

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • W

    Parameters

    • value: number
    • iteratee: W

    Returns number

sortedIndexOf

  • sortedIndexOf(value: number): number

sortedLastIndex

  • sortedLastIndex<TSort>(value: number): number
  • sortedLastIndex(value: number): number
  • sortedLastIndex<W>(value: number): number

sortedLastIndexBy

  • sortedLastIndexBy<TSort>(value: number, iteratee: function): number
  • sortedLastIndexBy(value: number, iteratee: string): number
  • sortedLastIndexBy<W>(value: number, iteratee: W): number
  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: number
    • iteratee: function
        • (x: number): TSort
        • Parameters

          • x: number

          Returns TSort

    Returns number

  • see

    _.sortedLastIndexBy

    Parameters

    • value: number
    • iteratee: string

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    Parameters

    • value: number
    • iteratee: W

    Returns number

sortedUniq

sortedUniqBy

splice

sum

  • sum(): number

sumBy

  • sumBy(iteratee: ListIterator<number, number>): number
  • sumBy(iteratee: string): number
  • sumBy(): number

tail

take

takeRight

takeRightWhile

takeWhile

toArray

transform

union

unionBy

uniq

uniqBy

unshift

unzip

unzipWith

without

wrap

xor

zip

zipObject

zipWith

LoDashImplicitObjectWrapper

LoDashImplicitObjectWrapper:

ary

  • see

    _.ary

    Type parameters

    • TResult: Function

    Parameters

    • Optional n: number

    Returns LoDashImplicitObjectWrapper<TResult>

assign

  • see

    _.assign

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    • source: TSource

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.assign

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.assign

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

assignIn

  • see

    _.assignIn

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    • source: TSource

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignIn

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.assignIn

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.assignIn

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

assignInWith

  • see

    _.assignInWith

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignInWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.assignInWith

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.assignInWith

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

assignWith

  • see

    _.assignWith

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assignWith

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.assignWith

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.assignWith

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

at

  • see

    _.at

    Type parameters

    • T

    Parameters

    • Rest ...props: number | string | Array<number | string>

    Returns LoDashImplicitArrayWrapper<T>

attempt

  • attempt<TResult>(...args: any[]): TResult | Error
  • see

    _.attempt

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns TResult | Error

bind

  • see

    _.bind

    Type parameters

    • TResult: Function

    Parameters

    • thisArg: any
    • Rest ...partials: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

bindAll

  • see

    _.bindAll

    Parameters

    • Rest ...methodNames: string | Array<string>

    Returns LoDashImplicitObjectWrapper<T>

bindKey

  • see

    _.bindKey

    Type parameters

    • TResult: Function

    Parameters

    • key: any
    • Rest ...partials: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

chain

chunk

  • see

    _.chunk

    Type parameters

    • TResult

    Parameters

    • Optional size: number

    Returns LoDashImplicitArrayWrapper<TResult[]>

clone

  • clone(): T
  • clone(customizer: function): T
  • see

    _.clone

    Returns T

  • see

    _.clone

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

cloneDeep

  • cloneDeep(): T
  • cloneDeep(customizer: function): T
  • see

    _.cloneDeep

    Returns T

  • see

    _.cloneDeep

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

commit

compact

  • see

    _.compact

    Type parameters

    • TResult

    Returns LoDashImplicitArrayWrapper<TResult>

concat

constant

countBy

create

  • see

    _.create

    Type parameters

    • U: Object

    Parameters

    • Optional properties: U

    Returns LoDashImplicitObjectWrapper<T & U>

createCallback

  • see

    _.createCallback

    Parameters

    • Optional thisArg: any
    • Optional argCount: number

    Returns LoDashImplicitObjectWrapper<function>

curry

  • see

    _.curry

    Type parameters

    • TResult: Function

    Parameters

    • Optional arity: number

    Returns LoDashImplicitObjectWrapper<TResult>

curryRight

  • see

    _.curryRight

    Type parameters

    • TResult: Function

    Parameters

    • Optional arity: number

    Returns LoDashImplicitObjectWrapper<TResult>

debounce

defaults

  • see

    _.defaults

    Type parameters

    • S1: object

    • TResult: object

    Parameters

    • source1: S1
    • Rest ...sources: object[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • Rest ...sources: object[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • S3: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • source3: S3
    • Rest ...sources: object[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.defaults

    Type parameters

    • S1: object

    • S2: object

    • S3: object

    • S4: object

    • TResult: object

    Parameters

    • source1: S1
    • source2: S2
    • source3: S3
    • source4: S4
    • Rest ...sources: object[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.defaults

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.defaults

    Type parameters

    • TResult

    Parameters

    • Rest ...sources: object[]

    Returns LoDashImplicitObjectWrapper<TResult>

defaultsDeep

  • see

    _.defaultsDeep

    Type parameters

    • TResult

    Parameters

    • Rest ...sources: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

defer

  • see

    _.defer

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitWrapper<number>

delay

  • see

    _.delay

    Parameters

    • wait: number
    • Rest ...args: any[]

    Returns LoDashImplicitWrapper<number>

difference

  • see

    _.difference

    Type parameters

    • TValue

    Parameters

    • Rest ...values: Array<TValue> | List<TValue>

    Returns LoDashImplicitArrayWrapper<TValue>

differenceBy

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: function | string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • Rest ...values: any[]

    Returns LoDashImplicitArrayWrapper<T>

drop

  • see

    _.drop

    Type parameters

    • T

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<T>

dropRight

  • see

    _.dropRight

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<TResult>

dropRightWhile

  • see

    _.dropRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.dropRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.dropRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<TValue>

dropWhile

  • see

    _.dropWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.dropWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.dropWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<TValue>

each

eachRight

eq

  • eq(other: any): boolean
  • see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

every

  • see

    _.every

    Type parameters

    • TResult

    Parameters

    Returns boolean

  • see

    _.every

    Parameters

    • Optional predicate: string | any[]

    Returns boolean

  • see

    _.every

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns boolean

extend

  • see

    _.assign

    Type parameters

    • TSource: object

    • TResult: object

    Parameters

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    assign

    Type parameters

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.assign

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.assign

    Type parameters

    • TResult: object

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

fill

  • see

    _.fill

    Type parameters

    • T

    Parameters

    • value: T
    • Optional start: number
    • Optional end: number

    Returns LoDashImplicitObjectWrapper<List<T>>

filter

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • predicate: W

    Returns LoDashImplicitArrayWrapper<T>

find

  • find<TResult>(predicate?: ListIterator<TResult, boolean> | DictionaryIterator<TResult, boolean>, thisArg?: any): TResult
  • find<TResult>(predicate?: string, thisArg?: any): TResult
  • find<TObject, TResult>(predicate?: TObject): TResult
  • see

    _.find

    Type parameters

    • TResult

    Parameters

    Returns TResult

  • see

    _.find

    Type parameters

    • TResult

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns TResult

  • see

    _.find

    Type parameters

    • TObject: object

    • TResult

    Parameters

    • Optional predicate: TObject

    Returns TResult

findIndex

  • findIndex<TResult>(predicate?: ListIterator<TResult, boolean>, thisArg?: any): number
  • findIndex(predicate?: string, thisArg?: any): number
  • findIndex<W>(predicate?: W): number
  • see

    _.findIndex

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns number

findKey

  • findKey<TValues>(predicate?: DictionaryIterator<TValues, boolean>, thisArg?: any): string
  • findKey(predicate?: ObjectIterator<any, boolean>, thisArg?: any): string
  • findKey(predicate?: string, thisArg?: any): string
  • findKey<TWhere>(predicate?: TWhere): string
  • see

    _.findKey

    Type parameters

    • TValues

    Parameters

    Returns string

  • see

    _.findKey

    Parameters

    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns string

  • see

    _.findKey

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns string

  • see

    _.findKey

    Type parameters

    Parameters

    • Optional predicate: TWhere

    Returns string

findLastIndex

  • findLastIndex<TResult>(predicate?: ListIterator<TResult, boolean>, thisArg?: any): number
  • findLastIndex(predicate?: string, thisArg?: any): number
  • findLastIndex<W>(predicate?: W): number
  • see

    _.findLastIndex

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findLastIndex

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • W

    Parameters

    • Optional predicate: W

    Returns number

findLastKey

  • findLastKey<TValues>(predicate?: DictionaryIterator<TValues, boolean>, thisArg?: any): string
  • findLastKey(predicate?: ObjectIterator<any, boolean>, thisArg?: any): string
  • findLastKey(predicate?: string, thisArg?: any): string
  • findLastKey<TWhere>(predicate?: TWhere): string
  • see

    _.findLastKey

    Type parameters

    • TValues

    Parameters

    Returns string

  • see

    _.findLastKey

    Parameters

    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns string

  • see

    _.findLastKey

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns string

  • see

    _.findLastKey

    Type parameters

    Parameters

    • Optional predicate: TWhere

    Returns string

first

  • first<TResult>(): TResult
  • see

    _.head

    Type parameters

    • TResult

    Returns TResult

flatten

  • see

    _.flatten

    Type parameters

    • TResult

    Parameters

    • Optional isDeep: boolean

    Returns LoDashImplicitArrayWrapper<TResult>

flattenDeep

  • see

    _.flattenDeep

    Type parameters

    • T

    Returns LoDashImplicitArrayWrapper<T>

flip

flow

  • see

    _.flow

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashImplicitObjectWrapper<TResult>

flowRight

  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashImplicitObjectWrapper<TResult>

forEach

forEachRight

forIn

forInRight

forOwn

forOwnRight

functions

functionsIn

get

  • get<TResult>(path: string | number | boolean | Array<string | number | boolean>, defaultValue?: TResult): TResult
  • see

    _.get

    Type parameters

    • TResult

    Parameters

    • path: string | number | boolean | Array<string | number | boolean>
    • Optional defaultValue: TResult

    Returns TResult

groupBy

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

has

hasIn

head

  • head<TResult>(): TResult
  • see

    _.first

    Type parameters

    • TResult

    Returns TResult

identity

  • identity(): T
  • see

    _.identity

    Returns T

includes

  • includes<TValue>(target: TValue, fromIndex?: number): boolean
  • see

    _.includes

    Type parameters

    • TValue

    Parameters

    • target: TValue
    • Optional fromIndex: number

    Returns boolean

indexOf

  • indexOf<TValue>(value: TValue, fromIndex?: boolean | number): number
  • see

    _.indexOf

    Type parameters

    • TValue

    Parameters

    • value: TValue
    • Optional fromIndex: boolean | number

    Returns number

initial

intersection

  • see

    _.intersection

    Type parameters

    • TResult

    Parameters

    • Rest ...arrays: Array<TResult> | List<TResult>

    Returns LoDashImplicitArrayWrapper<TResult>

invert

  • see

    _.invert

    Type parameters

    • TResult: object

    Parameters

    • Optional multiValue: boolean

    Returns LoDashImplicitObjectWrapper<TResult>

invokeMap

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • methodName: string
    • Rest ...args: any[]

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns LoDashImplicitArrayWrapper<TResult>

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean

isArrayLike

  • isArrayLike(): boolean

isArrayLikeObject

  • isArrayLikeObject(): boolean

isBoolean

  • isBoolean(): boolean

isDate

  • isDate(): boolean

isElement

  • isElement(): boolean

isEmpty

  • isEmpty(): boolean

isEqual

  • isEqual(other: any): boolean

isEqualWith

isError

  • isError(): boolean

isFinite

  • isFinite(): boolean

isFunction

  • isFunction(): boolean

isInteger

  • isInteger(): boolean

isLength

  • isLength(): boolean

isMatch

  • isMatch(source: Object): boolean
  • see

    _.isMatch

    Parameters

    • source: Object

    Returns boolean

isMatchWith

  • see

    _.isMatchWith

    Parameters

    Returns boolean

isNaN

  • isNaN(): boolean

isNative

  • isNative(): boolean

isNil

  • isNil(): boolean

isNull

  • isNull(): boolean

isNumber

  • isNumber(): boolean

isObject

  • isObject(): boolean

isObjectLike

  • isObjectLike(): boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean

isSafeInteger

  • isSafeInteger(): boolean

isString

  • isString(): boolean

isSymbol

  • isSymbol(): boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

iteratee

  • see

    _.iteratee

    Parameters

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<function>

  • see

    _.iteratee

    Type parameters

    • TResult

    Parameters

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<function>

join

  • join(separator?: string): string
  • see

    _.join

    Parameters

    • Optional separator: string

    Returns string

keyBy

keys

keysIn

last

  • last<T>(): T
  • see

    _.last

    Type parameters

    • T

    Returns T

lastIndexOf

  • lastIndexOf<TResult>(value: TResult, fromIndex?: boolean | number): number
  • see

    _.lastIndexOf

    Type parameters

    • TResult

    Parameters

    • value: TResult
    • Optional fromIndex: boolean | number

    Returns number

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

map

  • see

    _.map

    Type parameters

    • TValue

    • TResult

    Parameters

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TValue

    • TResult

    Parameters

    • Optional iteratee: string

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TObject: object

    Parameters

    • Optional iteratee: TObject

    Returns LoDashImplicitArrayWrapper<boolean>

mapKeys

mapValues

  • see

    _.mapValues TValue is the type of the property values of T. TResult is the type output by the ObjectIterator function

    Type parameters

    • TValue

    • TResult

    Parameters

    Returns LoDashImplicitObjectWrapper<Dictionary<TResult>>

  • see

    _.mapValues TResult is the type of the property specified by pluck. T should be a Dictionary>

    Type parameters

    • TResult

    Parameters

    • pluck: string

    Returns LoDashImplicitObjectWrapper<Dictionary<TResult>>

  • see

    _.mapValues TResult is the type of the properties on the object specified by pluck. T should be a Dictionary>>

    Type parameters

    • TResult

    Parameters

    Returns LoDashImplicitArrayWrapper<Dictionary<boolean>>

  • see

    _.mapValues TResult is the type of the properties of each object in the values of T T should be a Dictionary>

    Type parameters

    • TResult

    Parameters

    Returns LoDashImplicitArrayWrapper<boolean>

matches

matchesProperty

max

  • max<T>(): T
  • see

    _.max

    Type parameters

    • T

    Returns T

maxBy

  • maxBy<T>(iteratee?: ListIterator<T, any> | DictionaryIterator<T, any>, thisArg?: any): T
  • maxBy<T>(iteratee?: string, thisArg?: any): T
  • maxBy<TObject, T>(whereValue?: TObject): T
  • see

    _.maxBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.maxBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: string
    • Optional thisArg: any

    Returns T

  • see

    _.maxBy

    Type parameters

    • TObject: object

    • T

    Parameters

    • Optional whereValue: TObject

    Returns T

memoize

  • see

    _.memoize

    Parameters

    • Optional resolver: Function

    Returns LoDashImplicitObjectWrapper<T & MemoizedFunction>

merge

  • see

    _.merge

    Type parameters

    • TSource

    Parameters

    • source: TSource

    Returns LoDashImplicitObjectWrapper<T & TSource>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    Parameters

    • source1: TSource1
    • source2: TSource2

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2 & TSource3>

  • see

    _.merge

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    • TSource4

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2 & TSource3 & TSource4>

  • see

    _.merge

    Type parameters

    • TResult

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

mergeWith

  • see

    _.mergeWith

    Type parameters

    • TSource

    Parameters

    Returns LoDashImplicitObjectWrapper<T & TSource>

  • see

    _.mergeWith

    Type parameters

    • TSource1

    • TSource2

    Parameters

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2>

  • see

    _.mergeWith

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    Parameters

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2 & TSource3>

  • see

    _.mergeWith

    Type parameters

    • TSource1

    • TSource2

    • TSource3

    • TSource4

    Parameters

    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: MergeWithCustomizer

    Returns LoDashImplicitObjectWrapper<T & TSource1 & TSource2 & TSource3 & TSource4>

  • see

    _.mergeWith

    Type parameters

    • TResult

    Parameters

    • Rest ...otherArgs: any[]

    Returns LoDashImplicitObjectWrapper<TResult>

methodOf

  • see

    _.methodOf

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitObjectWrapper<function>

min

  • min<T>(): T
  • see

    _.min

    Type parameters

    • T

    Returns T

minBy

  • minBy<T>(iteratee?: ListIterator<T, any> | DictionaryIterator<T, any>, thisArg?: any): T
  • minBy<T>(iteratee?: string, thisArg?: any): T
  • minBy<TObject, T>(whereValue?: TObject): T
  • see

    _.minBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.minBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: string
    • Optional thisArg: any

    Returns T

  • see

    _.minBy

    Type parameters

    • TObject: object

    • T

    Parameters

    • Optional whereValue: TObject

    Returns T

mixin

negate

noConflict

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

now

  • now(): number

omit

omitBy

once

orderBy

over

  • see

    _.over

    Type parameters

    • TResult

    Parameters

    • Rest ...iteratees: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

overArgs

  • see

    _.overArgs

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...transforms: Function[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.overArgs

    Type parameters

    • TResult: Function

    Parameters

    • transforms: Function[]

    Returns LoDashImplicitObjectWrapper<TResult>

overEvery

  • see

    _.overEvery

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

overSome

  • see

    _.overSome

    Parameters

    • Rest ...predicates: Function | Array<Function>

    Returns LoDashImplicitObjectWrapper<function>

partition

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • callback: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    Returns LoDashImplicitArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • W

    • TResult

    Parameters

    • whereValue: W

    Returns LoDashImplicitArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • path: string
    • srcValue: any

    Returns LoDashImplicitArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • pluckValue: string

    Returns LoDashImplicitArrayWrapper<TResult[]>

pick

pickBy

plant

propertyOf

pull

  • see

    _.pull

    Type parameters

    • TValue

    Parameters

    • Rest ...values: TValue[]

    Returns LoDashImplicitObjectWrapper<List<TValue>>

pullAt

  • see

    _.pullAt

    Type parameters

    • T

    Parameters

    • Rest ...indexes: number | Array<number>

    Returns LoDashImplicitArrayWrapper<T>

rearg

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • indexes: number[]

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...indexes: number[]

    Returns LoDashImplicitObjectWrapper<TResult>

reduce

  • reduce<TValue, TResult>(callback: MemoIterator<TValue, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TValue, TResult>(callback: MemoIterator<TValue, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • Optional thisArg: any

    Returns TResult

reject

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • W

    • T

    Parameters

    • predicate: W

    Returns LoDashImplicitArrayWrapper<T>

remove

  • see

    _.remove

    Type parameters

    • TResult

    Parameters

    • Optional predicate: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.remove

    Type parameters

    • TResult

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

  • see

    _.remove

    Type parameters

    • W

    • TResult

    Parameters

    • Optional predicate: W

    Returns LoDashImplicitArrayWrapper<TResult>

replace

  • replace(pattern?: RegExp | string, replacement?: Function | string): string
  • replace(replacement?: Function | string): string
  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns string

  • see

    _.replace

    Parameters

    • Optional replacement: Function | string

    Returns string

rest

  • see

    _.rest

    Type parameters

    • TResult: Function

    Parameters

    • Optional start: number

    Returns LoDashImplicitObjectWrapper<TResult>

result

  • result<TResult>(path: number | string | boolean | Array<number | string | boolean>, defaultValue?: TResult): TResult
  • see

    _.result

    Type parameters

    • TResult

    Parameters

    • path: number | string | boolean | Array<number | string | boolean>
    • Optional defaultValue: TResult

    Returns TResult

runInContext

  • see

    _.runInContext

    Returns LoDashStatic

set

setWith

shuffle

size

  • size(): number
  • see

    _.size

    Returns number

some

  • see

    _.some

    Type parameters

    • TResult

    Parameters

    Returns boolean

  • see

    _.some

    Parameters

    • Optional predicate: string | any[]

    Returns boolean

  • see

    _.some

    Type parameters

    • TObject: object

    Parameters

    • Optional predicate: TObject

    Returns boolean

sortBy

sortedIndex

  • sortedIndex<T, TSort>(value: T): number
  • sortedIndex<T>(value: T): number
  • sortedIndex<W, T>(value: T): number
  • see

    _.sortedIndex

    Type parameters

    • T

    • TSort

    Parameters

    • value: T

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • value: T

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • W

    • T

    Parameters

    • value: T

    Returns number

sortedIndexBy

  • sortedIndexBy<T, TSort>(value: T, iteratee: function): number
  • sortedIndexBy<T>(value: T, iteratee: function): number
  • sortedIndexBy<T>(value: T, iteratee: string): number
  • sortedIndexBy<W, T>(value: T, iteratee: W): number
  • sortedIndexBy<T>(value: T, iteratee: Object): number
  • see

    _.sortedIndexBy

    Type parameters

    • T

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • W

    • T

    Parameters

    • value: T
    • iteratee: W

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: Object

    Returns number

sortedIndexOf

  • sortedIndexOf<TValue>(value: TValue): number
  • see

    _.sortedIndexOf

    Type parameters

    • TValue

    Parameters

    • value: TValue

    Returns number

sortedLastIndex

  • sortedLastIndex<T, TSort>(value: T): number
  • sortedLastIndex<T>(value: T): number
  • sortedLastIndex<W, T>(value: T): number
  • see

    _.sortedLastIndex

    Type parameters

    • T

    • TSort

    Parameters

    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • T

    Parameters

    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • W

    • T

    Parameters

    • value: T

    Returns number

sortedLastIndexBy

  • sortedLastIndexBy<T, TSort>(value: T, iteratee: function): number
  • sortedLastIndexBy<T>(value: T, iteratee: function): number
  • sortedLastIndexBy<T>(value: T, iteratee: string): number
  • sortedLastIndexBy<W, T>(value: T, iteratee: W): number
  • sortedLastIndexBy<T>(value: T, iteratee: Object): number
  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    • TSort

    Parameters

    • value: T
    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    • T

    Parameters

    • value: T
    • iteratee: W

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • value: T
    • iteratee: Object

    Returns number

sortedUniq

sortedUniqBy

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • iteratee: string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • iteratee: Object

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.sortedUniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • iteratee: TWhere

    Returns LoDashImplicitArrayWrapper<T>

spread

  • see

    _.spread

    Type parameters

    • T: Function

    Returns LoDashImplicitObjectWrapper<T>

sum

  • sum<TValue>(): number
  • sum(): number
  • see

    _.sum

    Type parameters

    • TValue

    Returns number

  • see

    _.sum

    Returns number

sumBy

  • see

    _.sumBy

    Type parameters

    • TValue

    Parameters

    Returns number

  • see

    _.sumBy

    Parameters

    • iteratee: string

    Returns number

  • see

    _.sumBy

    Returns number

tail

take

  • see

    _.take

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<TResult>

takeRight

  • see

    _.takeRight

    Type parameters

    • TResult

    Parameters

    • Optional n: number

    Returns LoDashImplicitArrayWrapper<TResult>

takeRightWhile

  • see

    _.takeRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.takeRightWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.takeRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<TValue>

takeWhile

  • see

    _.takeWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: ListIterator<TValue, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.takeWhile

    Type parameters

    • TValue

    Parameters

    • Optional predicate: string
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TValue>

  • see

    _.takeWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • Optional predicate: TWhere

    Returns LoDashImplicitArrayWrapper<TValue>

tap

throttle

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

toArray

  • see

    _.toArray

    Type parameters

    • TResult

    Returns LoDashImplicitArrayWrapper<TResult>

toInteger

toLength

toNumber

toPairs

  • see

    _.toPairs

    Type parameters

    • TResult

    Returns LoDashImplicitArrayWrapper<TResult[]>

toPairsIn

  • see

    _.toPairsIn

    Type parameters

    • TResult

    Returns LoDashImplicitArrayWrapper<TResult[]>

toPath

toPlainObject

toSafeInteger

transform

unary

union

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T>

unionBy

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: W

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • Rest ...iteratee: any[]

    Returns LoDashImplicitArrayWrapper<T>

uniq

uniqBy

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • iteratee: string

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • iteratee: Object

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.uniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • iteratee: TWhere

    Returns LoDashImplicitArrayWrapper<T>

unset

unzip

unzipWith

  • see

    _.unzipWith

    Type parameters

    • TArr

    • TResult

    Parameters

    • Optional iteratee: MemoIterator<TArr, TResult>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

values

valuesIn

without

  • see

    _.without

    Type parameters

    • T

    Parameters

    • Rest ...values: T[]

    Returns LoDashImplicitArrayWrapper<T>

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashImplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashImplicitObjectWrapper<R>

xor

  • see

    _.xor

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T>

zip

  • see

    _.zip

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns LoDashImplicitArrayWrapper<T[]>

zipObject

  • see

    _.zipObject

    Type parameters

    • TValues

    • TResult: object

    Parameters

    • Optional values: List<TValues>

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    • Optional values: List<any>

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.zipObject

    Parameters

    • Optional values: List<any>

    Returns LoDashImplicitObjectWrapper<Dictionary<any>>

LoDashImplicitStringWrapper

LoDashImplicitStringWrapper:

add

  • add(addend: number): number
  • see

    _.add

    Parameters

    • addend: number

    Returns number

after

before

camelCase

  • camelCase(): string

capitalize

  • capitalize(): string

ceil

  • ceil(precision?: number): number
  • see

    _.ceil

    Parameters

    • Optional precision: number

    Returns number

chain

clamp

  • clamp(lower: number, upper: number): number
  • see

    _.clamp

    Parameters

    • lower: number
    • upper: number

    Returns number

clone

  • clone(): string

cloneDeep

  • cloneDeep(): string

countBy

createCallback

deburr

  • deburr(): string

each

eachRight

endsWith

  • endsWith(target?: string, position?: number): boolean
  • see

    _.endsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

escape

  • escape(): string

escapeRegExp

  • escapeRegExp(): string

filter

flatten

flattenDeep

floor

  • floor(precision?: number): number
  • see

    _.floor

    Parameters

    • Optional precision: number

    Returns number

forEach

forEachRight

groupBy

identity

  • identity(): string

inRange

  • inRange(start: number, end: number): boolean
  • inRange(end: number): boolean
  • see

    _.inRange

    Parameters

    • start: number
    • end: number

    Returns boolean

  • see

    _.inRange

    Parameters

    • end: number

    Returns boolean

includes

  • includes(target: string, fromIndex?: number): boolean
  • see

    _.includes

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns boolean

iteratee

join

  • join(separator?: string): string
  • see

    _.join

    Parameters

    • Optional separator: string

    Returns string

kebabCase

  • kebabCase(): string

keyBy

lowerCase

  • lowerCase(): string

lowerFirst

  • lowerFirst(): string

method

nthArg

orderBy

pad

  • pad(length?: number, chars?: string): string
  • see

    _.pad

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padEnd

  • padEnd(length?: number, chars?: string): string
  • see

    _.padEnd

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padStart

  • padStart(length?: number, chars?: string): string
  • see

    _.padStart

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

parseInt

  • parseInt(radix?: number): number
  • see

    _.parseInt

    Parameters

    • Optional radix: number

    Returns number

partition

  • see

    _.partition

    Parameters

    • callback: ListIterator<string, boolean>
    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<string[]>

property

random

  • random(max?: number, floating?: boolean): number
  • random(floating?: boolean): number
  • see

    _.random

    Parameters

    • Optional max: number
    • Optional floating: boolean

    Returns number

  • see

    _.random

    Parameters

    • Optional floating: boolean

    Returns number

range

rangeRight

reject

repeat

  • repeat(n?: number): string
  • see

    _.repeat

    Parameters

    • Optional n: number

    Returns string

replace

  • replace(pattern?: RegExp | string, replacement?: Function | string): string
  • replace(replacement?: Function | string): string
  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns string

  • see

    _.replace

    Parameters

    • Optional replacement: Function | string

    Returns string

round

  • round(precision?: number): number
  • see

    _.round

    Parameters

    • Optional precision: number

    Returns number

shuffle

size

  • size(): number

snakeCase

  • snakeCase(): string

sortedIndex

  • sortedIndex<TSort>(value: string): number
  • see

    _.sortedIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns number

sortedIndexBy

  • sortedIndexBy<TSort>(value: string, iteratee: function): number
  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns number

sortedLastIndex

  • sortedLastIndex<TSort>(value: string): number
  • see

    _.sortedLastIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns number

sortedLastIndexBy

  • sortedLastIndexBy<TSort>(value: string, iteratee: function): number
  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns number

sortedUniq

sortedUniqBy

split

startCase

  • startCase(): string

startsWith

  • startsWith(target?: string, position?: number): boolean
  • see

    _.startsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

subtract

  • subtract(subtrahend: number): number
  • see

    _.subtract

    Parameters

    • subtrahend: number

    Returns number

template

times

  • times<TResult>(iteratee: function): TResult[]
  • times(): number[]
  • see

    _.times

    Type parameters

    • TResult

    Parameters

    • iteratee: function
        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    Returns TResult[]

  • see

    _.times

    Returns number[]

toArray

toLower

  • toLower(): string

toUpper

  • toUpper(): string

trim

  • trim(chars?: string): string
  • see

    _.trim

    Parameters

    • Optional chars: string

    Returns string

trimEnd

  • trimEnd(chars?: string): string
  • see

    _.trimEnd

    Parameters

    • Optional chars: string

    Returns string

trimStart

  • trimStart(chars?: string): string
  • see

    _.trimStart

    Parameters

    • Optional chars: string

    Returns string

truncate

unescape

  • unescape(): string

uniq

uniqBy

uniqueId

  • uniqueId(): string

upperCase

  • upperCase(): string

upperFirst

  • upperFirst(): string

words

  • words(pattern?: string | RegExp): string[]
  • see

    _.words

    Parameters

    • Optional pattern: string | RegExp

    Returns string[]

wrap

LoDashImplicitWrapper

LoDashImplicitWrapper:

add

  • add(addend: number): number
  • see

    _.add

    Parameters

    • addend: number

    Returns number

after

  • see

    _.after

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns LoDashImplicitObjectWrapper<TFunc>

before

  • see

    _.before

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns LoDashImplicitObjectWrapper<TFunc>

camelCase

  • camelCase(): string
  • see

    _.camelCase

    Returns string

capitalize

  • capitalize(): string
  • see

    _.capitalize

    Returns string

ceil

  • ceil(precision?: number): number
  • see

    _.ceil

    Parameters

    • Optional precision: number

    Returns number

chain

clamp

  • clamp(lower: number, upper: number): number
  • see

    _.clamp

    Parameters

    • lower: number
    • upper: number

    Returns number

clone

  • clone(): T
  • clone(customizer: function): T
  • see

    _.clone

    Returns T

  • see

    _.clone

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

cloneDeep

  • cloneDeep(): T
  • cloneDeep(customizer: function): T
  • see

    _.cloneDeep

    Returns T

  • see

    _.cloneDeep

    Parameters

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

commit

concat

constant

countBy

createCallback

  • see

    _.createCallback

    Parameters

    • Optional thisArg: any
    • Optional argCount: number

    Returns LoDashImplicitObjectWrapper<function>

deburr

  • deburr(): string
  • see

    _.deburr

    Returns string

each

  • see

    _.forEach

    Parameters

    Returns LoDashImplicitWrapper<string>

eachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashImplicitWrapper<string>

endsWith

  • endsWith(target?: string, position?: number): boolean
  • see

    _.endsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

eq

  • eq(other: any): boolean
  • see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

escape

  • escape(): string
  • see

    _.escape

    Returns string

escapeRegExp

  • escapeRegExp(): string
  • see

    _.escapeRegExp

    Returns string

filter

flatten

flattenDeep

floor

  • floor(precision?: number): number
  • see

    _.floor

    Parameters

    • Optional precision: number

    Returns number

forEach

  • see

    _.forEach

    Parameters

    Returns LoDashImplicitWrapper<string>

forEachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashImplicitWrapper<string>

groupBy

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

identity

  • identity(): T
  • see

    _.identity

    Returns T

inRange

  • inRange(start: number, end: number): boolean
  • inRange(end: number): boolean
  • see

    _.inRange

    Parameters

    • start: number
    • end: number

    Returns boolean

  • see

    _.inRange

    Parameters

    • end: number

    Returns boolean

includes

  • includes(target: string, fromIndex?: number): boolean
  • see

    _.includes

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns boolean

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean

isArrayLike

  • isArrayLike(): boolean

isArrayLikeObject

  • isArrayLikeObject(): boolean

isBoolean

  • isBoolean(): boolean

isDate

  • isDate(): boolean

isElement

  • isElement(): boolean

isEmpty

  • isEmpty(): boolean

isEqual

  • isEqual(other: any): boolean

isEqualWith

isError

  • isError(): boolean

isFinite

  • isFinite(): boolean

isFunction

  • isFunction(): boolean

isInteger

  • isInteger(): boolean

isLength

  • isLength(): boolean

isNaN

  • isNaN(): boolean

isNative

  • isNative(): boolean

isNil

  • isNil(): boolean

isNull

  • isNull(): boolean

isNumber

  • isNumber(): boolean

isObject

  • isObject(): boolean

isObjectLike

  • isObjectLike(): boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean

isSafeInteger

  • isSafeInteger(): boolean

isString

  • isString(): boolean

isSymbol

  • isSymbol(): boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

iteratee

  • see

    _.iteratee

    Type parameters

    • TResult

    Parameters

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<function>

join

  • join(separator?: string): string
  • see

    _.join

    Parameters

    • Optional separator: string

    Returns string

kebabCase

  • kebabCase(): string
  • see

    _.kebabCase

    Returns string

keyBy

lowerCase

  • lowerCase(): string
  • see

    _.lowerCase

    Returns string

lowerFirst

  • lowerFirst(): string
  • see

    _.lowerFirst

    Returns string

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

matches

matchesProperty

method

  • see

    _.method

    Type parameters

    • TObject

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitObjectWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashImplicitObjectWrapper<function>

noConflict

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

now

  • now(): number

nthArg

  • see

    _.nthArg

    Type parameters

    • TResult: Function

    Returns LoDashImplicitObjectWrapper<TResult>

orderBy

pad

  • pad(length?: number, chars?: string): string
  • see

    _.pad

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padEnd

  • padEnd(length?: number, chars?: string): string
  • see

    _.padEnd

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padStart

  • padStart(length?: number, chars?: string): string
  • see

    _.padStart

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

parseInt

  • parseInt(radix?: number): number
  • see

    _.parseInt

    Parameters

    • Optional radix: number

    Returns number

plant

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashImplicitObjectWrapper<function>

random

  • random(max?: number, floating?: boolean): number
  • random(floating?: boolean): number
  • see

    _.random

    Parameters

    • Optional max: number
    • Optional floating: boolean

    Returns number

  • see

    _.random

    Parameters

    • Optional floating: boolean

    Returns number

range

  • see

    _.range

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashImplicitArrayWrapper<number>

rangeRight

  • see

    _.rangeRight

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashImplicitArrayWrapper<number>

reject

repeat

  • repeat(n?: number): string
  • see

    _.repeat

    Parameters

    • Optional n: number

    Returns string

replace

  • replace(pattern?: RegExp | string, replacement?: Function | string): string
  • replace(replacement?: Function | string): string
  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns string

  • see

    _.replace

    Parameters

    • Optional replacement: Function | string

    Returns string

result

  • result<TResult>(path: number | string | boolean | Array<number | string | boolean>, defaultValue?: TResult): TResult
  • see

    _.result

    Type parameters

    • TResult

    Parameters

    • path: number | string | boolean | Array<number | string | boolean>
    • Optional defaultValue: TResult

    Returns TResult

round

  • round(precision?: number): number
  • see

    _.round

    Parameters

    • Optional precision: number

    Returns number

shuffle

size

  • size(): number
  • see

    _.size

    Returns number

snakeCase

  • snakeCase(): string
  • see

    _.snakeCase

    Returns string

sortedIndex

  • sortedIndex<TSort>(value: string): number
  • see

    _.sortedIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns number

sortedIndexBy

  • sortedIndexBy<TSort>(value: string, iteratee: function): number
  • see

    _.sortedIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns number

sortedLastIndex

  • sortedLastIndex<TSort>(value: string): number
  • see

    _.sortedLastIndex

    Type parameters

    • TSort

    Parameters

    • value: string

    Returns number

sortedLastIndexBy

  • sortedLastIndexBy<TSort>(value: string, iteratee: function): number
  • see

    _.sortedLastIndexBy

    Type parameters

    • TSort

    Parameters

    • value: string
    • iteratee: function
        • (x: string): TSort
        • Parameters

          • x: string

          Returns TSort

    Returns number

sortedUniq

  • see

    _.sortedUniq

    Type parameters

    • TSort

    Returns LoDashImplicitArrayWrapper<T>

sortedUniqBy

split

  • see

    _.split

    Parameters

    • Optional separator: RegExp | string
    • Optional limit: number

    Returns LoDashImplicitArrayWrapper<string>

startCase

  • startCase(): string
  • see

    _.startCase

    Returns string

startsWith

  • startsWith(target?: string, position?: number): boolean
  • see

    _.startsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

subtract

  • subtract(subtrahend: number): number
  • see

    _.subtract

    Parameters

    • subtrahend: number

    Returns number

tap

  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<T>

template

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

times

  • times<TResult>(iteratee: function): TResult[]
  • times(): number[]
  • see

    _.times

    Type parameters

    • TResult

    Parameters

    • iteratee: function
        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    Returns TResult[]

  • see

    _.times

    Returns number[]

toArray

  • see

    _.toArray

    Type parameters

    • TResult

    Returns LoDashImplicitArrayWrapper<TResult>

toInteger

toLength

toLower

  • toLower(): string
  • see

    _.toLower

    Returns string

toNumber

toPath

toPlainObject

toSafeInteger

toUpper

  • toUpper(): string
  • see

    _.toUpper

    Returns string

trim

  • trim(chars?: string): string
  • see

    _.trim

    Parameters

    • Optional chars: string

    Returns string

trimEnd

  • trimEnd(chars?: string): string
  • see

    _.trimEnd

    Parameters

    • Optional chars: string

    Returns string

trimStart

  • trimStart(chars?: string): string
  • see

    _.trimStart

    Parameters

    • Optional chars: string

    Returns string

truncate

  • see

    _.truncate

    Parameters

    Returns string

unescape

  • unescape(): string
  • see

    _.unescape

    Returns string

uniq

uniqBy

uniqueId

  • uniqueId(): string
  • see

    _.uniqueId

    Returns string

upperCase

  • upperCase(): string
  • see

    _.upperCase

    Returns string

upperFirst

  • upperFirst(): string
  • see

    _.upperFirst

    Returns string

words

  • words(pattern?: string | RegExp): string[]
  • see

    _.words

    Parameters

    • Optional pattern: string | RegExp

    Returns string[]

wrap

  • see

    _.wrap

    Type parameters

    • W: Function

    • R: Function

    Parameters

    • wrapper: W

    Returns LoDashImplicitObjectWrapper<R>

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • wrapper: Function

    Returns LoDashImplicitObjectWrapper<R>

LoDashImplicitWrapperBase

LoDashImplicitWrapperBase:

commit

  • commit(): TWrapper
  • Executes the chained sequence and returns the wrapped result.

    Returns TWrapper

    Returns the new lodash wrapper instance.

concat

  • Creates a new array joining a wrapped array with any additional arrays and/or values.

    Type parameters

    • TItem

    Parameters

    • Rest ...items: Array<TItem | Array<TItem>>

    Returns LoDashImplicitArrayWrapper<TItem>

    Returns the new concatenated array.

  • see

    _.concat

    Parameters

    • Rest ...items: Array<T | Array<T>>

    Returns LoDashImplicitArrayWrapper<T>

constant

  • see

    _.constant

    Type parameters

    • TResult

    Returns LoDashImplicitObjectWrapper<function>

eq

  • eq(other: any): boolean
  • see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

isArguments

  • isArguments(): boolean
  • see

    _.isArguments

    Returns boolean

isArray

  • isArray(): boolean
  • see

    _.isArray

    Returns boolean

isArrayLike

  • isArrayLike(): boolean
  • see

    _.isArrayLike

    Returns boolean

isArrayLikeObject

  • isArrayLikeObject(): boolean
  • see

    _.isArrayLikeObject

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean
  • see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean
  • see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean
  • see

    _.isEmpty

    Returns boolean

isEqual

  • isEqual(other: any): boolean
  • see

    _.isEqual

    Parameters

    • other: any

    Returns boolean

isEqualWith

  • see

    _.isEqualWith

    Parameters

    Returns boolean

isError

  • isError(): boolean
  • see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean
  • see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean
  • see

    _.isFunction

    Returns boolean

isInteger

  • isInteger(): boolean
  • see

    _.isInteger

    Returns boolean

isLength

  • isLength(): boolean
  • see

    _.isLength

    Returns boolean

isNaN

  • isNaN(): boolean
  • see

    _.isNaN

    Returns boolean

isNative

  • isNative(): boolean
  • see _.isNative

    Returns boolean

isNil

  • isNil(): boolean
  • see _.isNil

    Returns boolean

isNull

  • isNull(): boolean
  • see _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean
  • see _.isNumber

    Returns boolean

isObject

  • isObject(): boolean
  • see _.isObject

    Returns boolean

isObjectLike

  • isObjectLike(): boolean
  • see _.isObjectLike

    Returns boolean

isPlainObject

  • isPlainObject(): boolean
  • see _.isPlainObject

    Returns boolean

isRegExp

  • isRegExp(): boolean
  • see _.isRegExp

    Returns boolean

isSafeInteger

  • isSafeInteger(): boolean
  • see _.isSafeInteger

    Returns boolean

isString

  • isString(): boolean
  • see _.isString

    Returns boolean

isSymbol

  • isSymbol(): boolean
  • see _.isSymbol

    Returns boolean

isTypedArray

  • isTypedArray(): boolean
  • see _.isTypedArray

    Returns boolean

isUndefined

  • isUndefined(): boolean
  • see _.isUndefined

    Returns boolean

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

matches

  • see

    _.matches

    Type parameters

    • V

    Returns LoDashImplicitObjectWrapper<function>

matchesProperty

  • see

    _.matchesProperty

    Type parameters

    • SrcValue

    Parameters

    • srcValue: SrcValue

    Returns LoDashImplicitObjectWrapper<function>

  • see

    _.matchesProperty

    Type parameters

    • SrcValue

    • Value

    Parameters

    • srcValue: SrcValue

    Returns LoDashImplicitObjectWrapper<function>

noConflict

  • see

    _.noConflict

    Returns LoDashStatic

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

now

  • now(): number
  • see

    _.now

    Returns number

plant

  • Creates a clone of the chained sequence planting value as the wrapped value.

    Parameters

    • value: number

      The value to plant as the wrapped value.

    Returns LoDashImplicitWrapper<number>

    Returns the new lodash wrapper instance.

  • see

    _.plant

    Parameters

    • value: string

    Returns LoDashImplicitStringWrapper

  • see

    _.plant

    Parameters

    • value: boolean

    Returns LoDashImplicitWrapper<boolean>

  • see

    _.plant

    Parameters

    • value: number[]

    Returns LoDashImplicitNumberArrayWrapper

  • see

    _.plant

    Type parameters

    • T

    Parameters

    • value: T[]

    Returns LoDashImplicitArrayWrapper<T>

  • see

    _.plant

    Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashImplicitObjectWrapper<T>

  • see

    _.plant

    Parameters

    • value: any

    Returns LoDashImplicitWrapper<any>

result

  • result<TResult>(path: number | string | boolean | Array<number | string | boolean>, defaultValue?: TResult): TResult
  • see

    _.result

    Type parameters

    • TResult

    Parameters

    • path: number | string | boolean | Array<number | string | boolean>
    • Optional defaultValue: TResult

    Returns TResult

tap

  • tap(interceptor: function, thisArg?: any): TWrapper
  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • Optional thisArg: any

    Returns TWrapper

thru

  • see

    _.thru

    Type parameters

    • TResult: number

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: string

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: boolean

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult: object

    Parameters

    • interceptor: function
        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

    Returns LoDashImplicitObjectWrapper<TResult>

  • see

    _.thru

    Type parameters

    • TResult

    Parameters

    • interceptor: function
        • (value: T): TResult[]
        • Parameters

          • value: T

          Returns TResult[]

    • Optional thisArg: any

    Returns LoDashImplicitArrayWrapper<TResult>

toInteger

  • see

    _.toInteger

    Returns LoDashImplicitWrapper<number>

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toLength

  • see

    _.toLength

    Returns LoDashImplicitWrapper<number>

toNumber

  • see

    _.toNumber

    Returns LoDashImplicitWrapper<number>

toPath

  • see

    _.toPath

    Returns LoDashImplicitWrapper<string[]>

toPlainObject

  • see

    _.toPlainObject

    Type parameters

    • TResult: object

    Returns LoDashImplicitObjectWrapper<TResult>

toSafeInteger

  • see

    _.toSafeInteger

    Returns LoDashImplicitWrapper<number>

toString

  • toString(): string
  • Produces the result of coercing the unwrapped value to a string.

    Returns string

    Returns the coerced string value.

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    alias

    .toJSON, .valueOf

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T

LoDashStatic

  • Creates a lodash object which wraps the given value to enable intuitive method chaining.

    In addition to Lo-Dash methods, wrappers also have the following Array methods: concat, join, pop, push, reverse, shift, slice, sort, splice, and unshift

    Chaining is supported in custom builds as long as the value method is implicitly or explicitly included in the build.

    The chainable wrapper functions are: after, assign, bind, bindAll, bindKey, chain, chunk, compact, compose, concat, countBy, createCallback, curry, debounce, defaults, defer, delay, difference, filter, flatten, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, functions, groupBy, keyBy, initial, intersection, invert, invoke, keys, map, max, memoize, merge, min, object, omit, once, pairs, partial, partialRight, pick, pluck, pull, push, range, reject, remove, rest, reverse, sample, shuffle, slice, sort, sortBy, splice, tap, throttle, times, toArray, transform, union, uniq, unset, unshift, unzip, values, where, without, wrap, and zip

    The non-chainable wrapper functions are: clone, cloneDeep, contains, escape, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, has, identity, indexOf, isArguments, isArray, isBoolean, isDate, isElement, isEmpty, isEqual, isFinite, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isRegExp, isString, isUndefined, join, lastIndexOf, mixin, noConflict, parseInt, pop, random, reduce, reduceRight, result, shift, size, some, sortedIndex, runInContext, template, unescape, uniqueId, and value

    The wrapper functions first and last return wrapped values when n is provided, otherwise they return unwrapped values.

    Explicit chaining can be enabled by using the _.chain method.

    Parameters

    • value: number

    Returns LoDashImplicitWrapper<number>

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: string

    Returns LoDashImplicitStringWrapper

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: boolean

    Returns LoDashImplicitWrapper<boolean>

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: Array<number>

    Returns LoDashImplicitNumberArrayWrapper

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Type parameters

    • T

    Parameters

    • value: Array<T>

    Returns LoDashImplicitArrayWrapper<T>

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashImplicitObjectWrapper<T>

  • Array Chain Collection Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: any

    Returns LoDashImplicitWrapper<any>

VERSION

VERSION: string

The semantic version number.

bind

Creates a function that invokes func with the this binding of thisArg and prepends any additional _.bind arguments to those provided to the bound function.

The .bind.placeholder value, which defaults to in monolithic builds, may be used as a placeholder for partially applied arguments.

Note: Unlike native Function#bind this method does not set the "length" property of bound functions.

param

The function to bind.

param

The this binding of func.

param

The arguments to be partially applied.

returns

Returns the new bound function.

bindKey

Creates a function that invokes the method at object[key] and prepends any additional _.bindKey arguments to those provided to the bound function.

This method differs from _.bind by allowing bound functions to reference methods that may be redefined or don’t yet exist. See Peter Michaux’s article for more details.

The .bindKey.placeholder value, which defaults to in monolithic builds, may be used as a placeholder for partially applied arguments.

param

The object the method belongs to.

param

The key of the method.

param

The arguments to be partially applied.

returns

Returns the new bound function.

memoize

memoize: object

Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.

param

The function to have its output memoized.

param

The function to resolve the cache key.

returns

Returns the new memoizing function.

Type declaration

    • <T>(func: T, resolver?: Function): T & MemoizedFunction
    • Type parameters

      • T: Function

      Parameters

      • func: T
      • Optional resolver: Function

      Returns T & MemoizedFunction

  • Cache: MapCache

partial

partial: Partial

Creates a function that, when called, invokes func with any additional partial arguments prepended to those provided to the new function. This method is similar to _.bind except it does not alter the this binding.

param

The function to partially apply arguments to.

param

Arguments to be partially applied.

returns

The new partially applied function.

partialRight

partialRight: PartialRight

This method is like _.partial except that partial arguments are appended to those provided to the new function.

param

The function to partially apply arguments to.

param

Arguments to be partially applied.

returns

The new partially applied function.

templateSettings

templateSettings: TemplateSettings

By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.

add

  • add(augend: number, addend: number): number
  • Adds two numbers.

    Parameters

    • augend: number

      The first number to add.

    • addend: number

      The second number to add.

    Returns number

    Returns the sum.

after

  • after<TFunc>(n: number, func: TFunc): TFunc
  • The opposite of _.before; this method creates a function that invokes func once it’s called n or more times.

    Type parameters

    • TFunc: Function

    Parameters

    • n: number

      The number of calls before func is invoked.

    • func: TFunc

      The function to restrict.

    Returns TFunc

    Returns the new restricted function.

ary

  • ary<TResult>(func: Function, n?: number): TResult
  • ary<T, TResult>(func: T, n?: number): TResult
  • Creates a function that accepts up to n arguments ignoring any additional arguments.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to cap arguments for.

    • Optional n: number

      The arity cap.

    Returns TResult

    Returns the new function.

  • Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T
    • Optional n: number

    Returns TResult

assign

  • assign<TObject, TSource, TResult>(object: TObject, source: TSource): TResult
  • assign<TObject, TSource1, TSource2, TResult>(object: TObject, source1: TSource1, source2: TSource2): TResult
  • assign<TObject, TSource1, TSource2, TSource3, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3): TResult
  • assign<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4): TResult
  • assign<TObject>(object: TObject): TObject
  • assign<TObject, TResult>(object: TObject, ...otherArgs: any[]): TResult
  • Assigns own enumerable properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.

    Note: This method mutates object and is loosely based on Object.assign.

    static
    memberof

    _

    category

    Object

    example

    function Foo() { this.c = 3; }

    function Bar() { this.e = 5; }

    Foo.prototype.d = 4; Bar.prototype.f = 6;

    _.assign({ 'a': 1 }, new Foo, new Bar); // => { 'a': 1, 'c': 3, 'e': 5 }

    Type parameters

    • TObject: object

    • TSource: object

    • TResult: object

    Parameters

    • object: TObject

      The destination object.

    • source: TSource

    Returns TResult

    Returns object.

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2

    Returns TResult

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns TResult

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns TResult

  • see

    _.assign

    Type parameters

    • TObject: object

    Parameters

    • object: TObject

    Returns TObject

  • see

    _.assign

    Type parameters

    • TObject: object

    • TResult: object

    Parameters

    • object: TObject
    • Rest ...otherArgs: any[]

    Returns TResult

assignIn

  • assignIn<TObject, TSource, TResult>(object: TObject, source: TSource): TResult
  • assignIn<TObject, TSource1, TSource2, TResult>(object: TObject, source1: TSource1, source2: TSource2): TResult
  • assignIn<TObject, TSource1, TSource2, TSource3, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3): TResult
  • assignIn<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4): TResult
  • assignIn<TObject>(object: TObject): TObject
  • assignIn<TObject, TResult>(object: TObject, ...otherArgs: any[]): TResult
  • This method is like _.assign except that it iterates over own and inherited source properties.

    Note: This method mutates object.

    static
    memberof

    _

    alias

    extend

    category

    Object

    example

    function Foo() { this.b = 2; }

    function Bar() { this.d = 4; }

    Foo.prototype.c = 3; Bar.prototype.e = 5;

    _.assignIn({ 'a': 1 }, new Foo, new Bar); // => { 'a': 1, 'b': 2, 'c': 3, 'd': 4, 'e': 5 }

    Type parameters

    • TObject: object

    • TSource: object

    • TResult: object

    Parameters

    • object: TObject

      The destination object.

    • source: TSource

    Returns TResult

    Returns object.

  • see

    assignIn

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2

    Returns TResult

  • see

    assignIn

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns TResult

  • see

    assignIn

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns TResult

  • see

    _.assignIn

    Type parameters

    • TObject: object

    Parameters

    • object: TObject

    Returns TObject

  • see

    _.assignIn

    Type parameters

    • TObject: object

    • TResult: object

    Parameters

    • object: TObject
    • Rest ...otherArgs: any[]

    Returns TResult

assignInWith

  • assignInWith<TObject, TSource, TResult>(object: TObject, source: TSource, customizer: AssignCustomizer): TResult
  • assignInWith<TObject, TSource1, TSource2, TResult>(object: TObject, source1: TSource1, source2: TSource2, customizer: AssignCustomizer): TResult
  • assignInWith<TObject, TSource1, TSource2, TSource3, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer): TResult
  • assignInWith<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer): TResult
  • assignInWith<TObject>(object: TObject): TObject
  • assignInWith<TObject, TResult>(object: TObject, ...otherArgs: any[]): TResult
  • This method is like _.assignIn except that it accepts customizer which is invoked to produce the assigned values. If customizer returns undefined assignment is handled by the method instead. The customizer is invoked with five arguments: (objValue, srcValue, key, object, source).

    Note: This method mutates object.

    static
    memberof

    _

    alias

    extendWith

    category

    Object

    example

    function customizer(objValue, srcValue) { return _.isUndefined(objValue) ? srcValue : objValue; }

    var defaults = .partialRight(.assignInWith, customizer);

    defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); // => { 'a': 1, 'b': 2 }

    Type parameters

    • TObject: object

    • TSource: object

    • TResult: object

    Parameters

    • object: TObject

      The destination object.

    • source: TSource
    • customizer: AssignCustomizer

    Returns TResult

    Returns object.

  • see

    assignInWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • customizer: AssignCustomizer

    Returns TResult

  • see

    assignInWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns TResult

  • see

    assignInWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns TResult

  • see

    _.assignInWith

    Type parameters

    • TObject: object

    Parameters

    • object: TObject

    Returns TObject

  • see

    _.assignInWith

    Type parameters

    • TObject: object

    • TResult: object

    Parameters

    • object: TObject
    • Rest ...otherArgs: any[]

    Returns TResult

assignWith

  • assignWith<TObject, TSource, TResult>(object: TObject, source: TSource, customizer: AssignCustomizer): TResult
  • assignWith<TObject, TSource1, TSource2, TResult>(object: TObject, source1: TSource1, source2: TSource2, customizer: AssignCustomizer): TResult
  • assignWith<TObject, TSource1, TSource2, TSource3, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: AssignCustomizer): TResult
  • assignWith<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: AssignCustomizer): TResult
  • assignWith<TObject>(object: TObject): TObject
  • assignWith<TObject, TResult>(object: TObject, ...otherArgs: any[]): TResult
  • This method is like _.assign except that it accepts customizer which is invoked to produce the assigned values. If customizer returns undefined assignment is handled by the method instead. The customizer is invoked with five arguments: (objValue, srcValue, key, object, source).

    Note: This method mutates object.

    static
    memberof

    _

    category

    Object

    example

    function customizer(objValue, srcValue) { return _.isUndefined(objValue) ? srcValue : objValue; }

    var defaults = .partialRight(.assignWith, customizer);

    defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 }); // => { 'a': 1, 'b': 2 }

    Type parameters

    • TObject: object

    • TSource: object

    • TResult: object

    Parameters

    • object: TObject

      The destination object.

    • source: TSource
    • customizer: AssignCustomizer

    Returns TResult

    Returns object.

  • see

    assignWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • customizer: AssignCustomizer

    Returns TResult

  • see

    assignWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: AssignCustomizer

    Returns TResult

  • see

    assignWith

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: AssignCustomizer

    Returns TResult

  • see

    _.assignWith

    Type parameters

    • TObject: object

    Parameters

    • object: TObject

    Returns TObject

  • see

    _.assignWith

    Type parameters

    • TObject: object

    • TResult: object

    Parameters

    • object: TObject
    • Rest ...otherArgs: any[]

    Returns TResult

at

  • at<T>(collection: List<T> | Dictionary<T>, ...props: number | string | Array<number | string>): T[]
  • Creates an array of elements corresponding to the given keys, or indexes, of collection. Keys may be specified as individual arguments or as arrays of keys.

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>

      The collection to iterate over.

    • Rest ...props: number | string | Array<number | string>

      The property names or indexes of elements to pick, specified individually or in arrays.

    Returns T[]

    Returns the new array of picked elements.

attempt

  • attempt<TResult>(func: function, ...args: any[]): TResult | Error
  • Attempts to invoke func, returning either the result or the caught error object. Any additional arguments are provided to func when it’s invoked.

    Type parameters

    • TResult

    Parameters

    • func: function

      The function to attempt.

        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns TResult | Error

    Returns the func result or error object.

before

  • before<TFunc>(n: number, func: TFunc): TFunc
  • Creates a function that invokes func, with the this binding and arguments of the created function, while it’s called less than n times. Subsequent calls to the created function return the result of the last func invocation.

    Type parameters

    • TFunc: Function

    Parameters

    • n: number

      The number of calls at which func is no longer invoked.

    • func: TFunc

      The function to restrict.

    Returns TFunc

    Returns the new restricted function.

bindAll

  • bindAll<T>(object: T, ...methodNames: string | Array<string>): T
  • Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all enumerable function properties, own and inherited, of object are bound.

    Note: This method does not set the "length" property of bound functions.

    Type parameters

    • T

    Parameters

    • object: T

      The object to bind and assign the bound methods to.

    • Rest ...methodNames: string | Array<string>

      The object method names to bind, specified as individual method names or arrays of method names.

    Returns T

    Returns object.

camelCase

  • camelCase(string?: string): string
  • Converts string to camel case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the camel cased string.

capitalize

  • capitalize(string?: string): string
  • Converts the first character of string to upper case and the remaining to lower case.

    Parameters

    • Optional string: string

      The string to capitalize.

    Returns string

    Returns the capitalized string.

ceil

  • ceil(n: number, precision?: number): number
  • Calculates n rounded up to precision.

    Parameters

    • n: number

      The number to round up.

    • Optional precision: number

      The precision to round up to.

    Returns number

    Returns the rounded up number.

chain

  • Creates a lodash object that wraps value with explicit method chaining enabled.

    Parameters

    • value: number

      The value to wrap.

    Returns LoDashExplicitWrapper<number>

    Returns the new lodash wrapper instance.

  • Parameters

    • value: string

    Returns LoDashExplicitWrapper<string>

  • Parameters

    • value: boolean

    Returns LoDashExplicitWrapper<boolean>

  • Type parameters

    • T

    Parameters

    • value: T[]

    Returns LoDashExplicitArrayWrapper<T>

  • Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashExplicitObjectWrapper<T>

  • Parameters

    • value: any

    Returns LoDashExplicitWrapper<any>

chunk

  • chunk<T>(array: List<T>, size?: number): T[]
  • Creates an array of elements split into groups the length of size. If collection can’t be split evenly, the final chunk will be the remaining elements.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to process.

    • Optional size: number

      The length of each chunk.

    Returns T[]

    Returns the new array containing chunks.

clamp

  • clamp(number: number, lower: number, upper: number): number
  • Clamps number within the inclusive lower and upper bounds.

    static
    memberof

    _

    category

    Number

    example

    _.clamp(-10, -5, 5); // => -5

    _.clamp(10, -5, 5); // => 5

    Parameters

    • number: number

      The number to clamp.

    • lower: number
    • upper: number

      The upper bound.

    Returns number

    Returns the clamped number.

clone

  • clone<T>(value: T): T
  • clone<T>(value: T, customizer: function): T
  • Creates a shallow clone of value.

    Note: This method is loosely based on the structured clone algorithm and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

    static
    memberof

    _

    category

    Lang

    example

    var objects = [{ 'a': 1 }, { 'b': 2 }];

    var shallow = _.clone(objects); console.log(shallow[0] === objects[0]); // => true

    Type parameters

    • T

    Parameters

    • value: T

      The value to clone.

    Returns T

    Returns the cloned value.

  • Creates a shallow clone of value.

    Note: This method is loosely based on the structured clone algorithm and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of arguments objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

    static
    memberof

    _

    category

    Lang

    example

    var objects = [{ 'a': 1 }, { 'b': 2 }];

    var shallow = _.clone(objects); console.log(shallow[0] === objects[0]); // => true

    Type parameters

    • T

    Parameters

    • value: T

      The value to clone.

    • customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

    Returns the cloned value.

cloneDeep

  • cloneDeep<T>(value: T): T
  • cloneDeep<T>(value: T, customizer: function): T
  • This method is like _.clone except that it recursively clones value.

    static
    memberof

    _

    category

    Lang

    example

    var objects = [{ 'a': 1 }, { 'b': 2 }];

    var deep = _.cloneDeep(objects); console.log(deep[0] === objects[0]); // => false

    Type parameters

    • T

    Parameters

    • value: T

      The value to recursively clone.

    Returns T

    Returns the deep cloned value.

  • Creates a deep clone of value. If customizer is provided it’s invoked to produce the cloned values. If customizer returns undefined cloning is handled by the method instead. The customizer is bound to thisArg and invoked with up to three argument; (value [, index|key, object]). Note: This method is loosely based on the structured clone algorithm. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. An empty object is returned for uncloneable values such as functions, DOM nodes, Maps, Sets, and WeakMaps.

    Type parameters

    • T

    Parameters

    • value: T

      The value to deep clone.

    • customizer: function

      The function to customize cloning values.

        • (value: any): any
        • Parameters

          • value: any

          Returns any

    Returns T

    Returns the deep cloned value.

compact

  • compact<T>(array?: List<T>): T[]
  • Creates an array with all falsey values removed. The values false, null, 0, "", undefined, and NaN are falsey.

    Type parameters

    • T

    Parameters

    • Optional array: List<T>

      The array to compact.

    Returns T[]

    (Array) Returns the new array of filtered values.

concat

  • concat<T>(...values: Array<T> | List<T>): T[]
  • Creates a new array concatenating array with any additional arrays and/or values.

    static
    memberof

    _

    category

    Array

    example

    var array = [1]; var other = _.concat(array, 2, [3], [[4]]);

    console.log(other); // => [1, 2, 3, [4]]

    console.log(array); // => [1]

    Type parameters

    • T

    Parameters

    • Rest ...values: Array<T> | List<T>

    Returns T[]

    Returns the new concatenated array.

constant

  • constant<T>(value: T): function
  • Creates a function that returns value.

    Type parameters

    • T

    Parameters

    • value: T

      The value to return from the new function.

    Returns function

    Returns the new function.

      • (): T
      • Returns T

countBy

  • Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is the number of times the key was returned by iteratee. The iteratee is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for iteratee the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for iteratee the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<number>

    Returns the composed aggregate object.

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • W

    • T

    Parameters

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<number>

create

  • create<T, U>(prototype: T, properties?: U): T & U
  • Creates an object that inherits from the given prototype object. If a properties object is provided its own enumerable properties are assigned to the created object.

    Type parameters

    • T: Object

    • U: Object

    Parameters

    • prototype: T

      The object to inherit from.

    • Optional properties: U

      The properties to assign to the object.

    Returns T & U

    Returns the new object.

createCallback

  • createCallback(func: string, thisArg?: any, argCount?: number): function
  • createCallback(func: Dictionary<any>, thisArg?: any, argCount?: number): function
  • Produces a callback bound to an optional thisArg. If func is a property name the created callback will return the property value for a given element. If func is an object the created callback will return true for elements that contain the equivalent object properties, otherwise it will return false.

    Parameters

    • func: string

      The value to convert to a callback.

    • Optional thisArg: any

      The this binding of the created callback.

    • Optional argCount: number

      The number of arguments the callback accepts.

    Returns function

    A callback function.

      • (): any
      • Returns any

  • see

    _.createCallback

    Parameters

    • func: Dictionary<any>
    • Optional thisArg: any
    • Optional argCount: number

    Returns function

      • (): boolean
      • Returns boolean

curry

  • curry<T1, R>(func: function): CurriedFunction1<T1, R>
  • curry<T1, T2, R>(func: function): CurriedFunction2<T1, T2, R>
  • curry<T1, T2, T3, R>(func: function): CurriedFunction3<T1, T2, T3, R>
  • curry<T1, T2, T3, T4, R>(func: function): CurriedFunction4<T1, T2, T3, T4, R>
  • curry<T1, T2, T3, T4, T5, R>(func: function): CurriedFunction5<T1, T2, T3, T4, T5, R>
  • curry<TResult>(func: Function, arity?: number): TResult
  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • T1

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1): R
        • Parameters

          • t1: T1

          Returns R

    Returns CurriedFunction1<T1, R>

    Returns the new curried function.

  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • T1

    • T2

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2): R
        • Parameters

          • t1: T1
          • t2: T2

          Returns R

    Returns CurriedFunction2<T1, T2, R>

    Returns the new curried function.

  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3

          Returns R

    Returns CurriedFunction3<T1, T2, T3, R>

    Returns the new curried function.

  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3, t4: T4): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3
          • t4: T4

          Returns R

    Returns CurriedFunction4<T1, T2, T3, T4, R>

    Returns the new curried function.

  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3
          • t4: T4
          • t5: T5

          Returns R

    Returns CurriedFunction5<T1, T2, T3, T4, T5, R>

    Returns the new curried function.

  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to curry.

    • Optional arity: number

      The arity of func.

    Returns TResult

    Returns the new curried function.

curryRight

  • curryRight<T1, R>(func: function): CurriedFunction1<T1, R>
  • curryRight<T1, T2, R>(func: function): CurriedFunction2<T2, T1, R>
  • curryRight<T1, T2, T3, R>(func: function): CurriedFunction3<T3, T2, T1, R>
  • curryRight<T1, T2, T3, T4, R>(func: function): CurriedFunction4<T4, T3, T2, T1, R>
  • curryRight<T1, T2, T3, T4, T5, R>(func: function): CurriedFunction5<T5, T4, T3, T2, T1, R>
  • curryRight<TResult>(func: Function, arity?: number): TResult
  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • T1

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1): R
        • Parameters

          • t1: T1

          Returns R

    Returns CurriedFunction1<T1, R>

    Returns the new curried function.

  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • T1

    • T2

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2): R
        • Parameters

          • t1: T1
          • t2: T2

          Returns R

    Returns CurriedFunction2<T2, T1, R>

    Returns the new curried function.

  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3

          Returns R

    Returns CurriedFunction3<T3, T2, T1, R>

    Returns the new curried function.

  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3, t4: T4): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3
          • t4: T4

          Returns R

    Returns CurriedFunction4<T4, T3, T2, T1, R>

    Returns the new curried function.

  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • R

    Parameters

    • func: function

      The function to curry.

        • (t1: T1, t2: T2, t3: T3, t4: T4, t5: T5): R
        • Parameters

          • t1: T1
          • t2: T2
          • t3: T3
          • t4: T4
          • t5: T5

          Returns R

    Returns CurriedFunction5<T5, T4, T3, T2, T1, R>

    Returns the new curried function.

  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to curry.

    • Optional arity: number

      The arity of func.

    Returns TResult

    Returns the new curried function.

debounce

  • debounce<T>(func: T, wait?: number, options?: DebounceSettings): T & Cancelable
  • Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function return the result of the last func invocation.

    Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.

    See David Corbacho’s article for details over the differences between .debounce and .throttle.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to debounce.

    • Optional wait: number

      The number of milliseconds to delay.

    • Optional options: DebounceSettings

      The options object.

    Returns T & Cancelable

    Returns the new debounced function.

deburr

  • deburr(string?: string): string
  • Deburrs string by converting latin-1 supplementary letters to basic latin letters and removing combining diacritical marks.

    Parameters

    • Optional string: string

      The string to deburr.

    Returns string

    Returns the deburred string.

defaults

  • defaults<Obj, TResult>(object: Obj, ...sources: object[]): TResult
  • defaults<Obj, S1, TResult>(object: Obj, source1: S1, ...sources: object[]): TResult
  • defaults<Obj, S1, S2, TResult>(object: Obj, source1: S1, source2: S2, ...sources: object[]): TResult
  • defaults<Obj, S1, S2, S3, TResult>(object: Obj, source1: S1, source2: S2, source3: S3, ...sources: object[]): TResult
  • defaults<Obj, S1, S2, S3, S4, TResult>(object: Obj, source1: S1, source2: S2, source3: S3, source4: S4, ...sources: object[]): TResult
  • defaults<TResult>(object: object, ...sources: object[]): TResult
  • Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to undefined. Once a property is set, additional values of the same property are ignored.

    Note: This method mutates object.

    Type parameters

    • Obj: object

    • TResult: object

    Parameters

    • object: Obj

      The destination object.

    • Rest ...sources: object[]

      The source objects.

    Returns TResult

    The destination object.

  • see

    _.defaults

    Type parameters

    • Obj: object

    • S1: object

    • TResult: object

    Parameters

    • object: Obj
    • source1: S1
    • Rest ...sources: object[]

    Returns TResult

  • see

    _.defaults

    Type parameters

    • Obj: object

    • S1: object

    • S2: object

    • TResult: object

    Parameters

    • object: Obj
    • source1: S1
    • source2: S2
    • Rest ...sources: object[]

    Returns TResult

  • see

    _.defaults

    Type parameters

    • Obj: object

    • S1: object

    • S2: object

    • S3: object

    • TResult: object

    Parameters

    • object: Obj
    • source1: S1
    • source2: S2
    • source3: S3
    • Rest ...sources: object[]

    Returns TResult

  • see

    _.defaults

    Type parameters

    • Obj: object

    • S1: object

    • S2: object

    • S3: object

    • S4: object

    • TResult: object

    Parameters

    • object: Obj
    • source1: S1
    • source2: S2
    • source3: S3
    • source4: S4
    • Rest ...sources: object[]

    Returns TResult

  • see

    _.defaults

    Type parameters

    • TResult: object

    Parameters

    • object: object
    • Rest ...sources: object[]

    Returns TResult

defaultsDeep

  • defaultsDeep<T, TResult>(object: T, ...sources: any[]): TResult
  • This method is like _.defaults except that it recursively assigns default properties.

    Type parameters

    • T

    • TResult

    Parameters

    • object: T

      The destination object.

    • Rest ...sources: any[]

      The source objects.

    Returns TResult

    Returns object.

defer

  • defer<T>(func: T, ...args: any[]): number
  • Defers invoking the func until the current call stack has cleared. Any additional arguments are provided to func when it’s invoked.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to defer.

    • Rest ...args: any[]

      The arguments to invoke the function with.

    Returns number

    Returns the timer id.

delay

  • delay<T>(func: T, wait: number, ...args: any[]): number
  • Invokes func after wait milliseconds. Any additional arguments are provided to func when it’s invoked.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to delay.

    • wait: number

      The number of milliseconds to delay invocation.

    • Rest ...args: any[]

      The arguments to invoke the function with.

    Returns number

    Returns the timer id.

difference

  • difference<T>(array: any[] | List<any>, ...values: any[]): T[]
  • Creates an array of unique array values not included in the other provided arrays using SameValueZero for equality comparisons.

    Type parameters

    • T

    Parameters

    • array: any[] | List<any>

      The array to inspect.

    • Rest ...values: any[]

      The arrays of values to exclude.

    Returns T[]

    Returns the new array of filtered values.

differenceBy

  • differenceBy<T>(array: T[] | List<T>, values?: T[] | List<T>, iteratee?: function | string): T[]
  • differenceBy<T, W>(array: T[] | List<T>, values?: T[] | List<T>, iteratee?: W): T[]
  • differenceBy<T>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, iteratee?: function | string): T[]
  • differenceBy<T, W>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, iteratee?: W): T[]
  • differenceBy<T>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, iteratee?: function | string): T[]
  • differenceBy<T, W>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, iteratee?: W): T[]
  • differenceBy<T, W>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, values4?: T[] | List<T>, iteratee?: W): T[]
  • differenceBy<T>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, values4?: T[] | List<T>, iteratee?: function | string): T[]
  • differenceBy<T>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, values4?: T[] | List<T>, values5?: T[] | List<T>, iteratee?: function | string): T[]
  • differenceBy<T, W>(array: T[] | List<T>, values1?: T[] | List<T>, values2?: T[] | List<T>, values3?: T[] | List<T>, values4?: T[] | List<T>, values5?: T[] | List<T>, iteratee?: W): T[]
  • differenceBy<T>(array: T[] | List<T>, ...values: any[]): T[]
  • This method is like _.difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>

      The array to inspect.

    • Optional values: T[] | List<T>

      The values to exclude.

    • Optional iteratee: function | string

      The iteratee invoked per element.

    Returns T[]

    Returns the new array of filtered values.

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • array: T[] | List<T>
    • Optional values: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: function | string

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: function | string

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional iteratee: function | string

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: function | string

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    • W: Object

    Parameters

    • array: T[] | List<T>
    • Optional values1: T[] | List<T>
    • Optional values2: T[] | List<T>
    • Optional values3: T[] | List<T>
    • Optional values4: T[] | List<T>
    • Optional values5: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.differenceBy

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>
    • Rest ...values: any[]

    Returns T[]

differenceWith

  • differenceWith(array: any[] | List<any>, ...values: any[]): any[]
  • Creates an array of unique array values not included in the other provided arrays using SameValueZero for equality comparisons.

    static
    memberof

    _

    category

    Array

    example

    _.difference([3, 2, 1], [4, 2]); // => [3, 1]

    Parameters

    • array: any[] | List<any>

      The array to inspect.

    • Rest ...values: any[]

    Returns any[]

    Returns the new array of filtered values.

drop

  • drop<T>(array: T[] | List<T>, n?: number): T[]
  • Creates a slice of array with n elements dropped from the beginning.

    Type parameters

    • T

    Parameters

    • array: T[] | List<T>

      The array to query.

    • Optional n: number

      The number of elements to drop.

    Returns T[]

    Returns the slice of array.

dropRight

  • dropRight<T>(array: List<T>, n?: number): T[]
  • Creates a slice of array with n elements dropped from the end.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    • Optional n: number

      The number of elements to drop.

    Returns T[]

    Returns the slice of array.

dropRightWhile

  • dropRightWhile<TValue>(array: List<TValue>, predicate?: ListIterator<TValue, boolean>, thisArg?: any): TValue[]
  • dropRightWhile<TValue>(array: List<TValue>, predicate?: string, thisArg?: any): TValue[]
  • dropRightWhile<TWhere, TValue>(array: List<TValue>, predicate?: TWhere): TValue[]
  • Creates a slice of array excluding elements dropped from the end. Elements are dropped until predicate returns falsey. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that match the properties of the given object, else false.

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>

      The array to query.

    • Optional predicate: ListIterator<TValue, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns TValue[]

    Returns the slice of array.

  • see

    _.dropRightWhile

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: string
    • Optional thisArg: any

    Returns TValue[]

  • see

    _.dropRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: TWhere

    Returns TValue[]

dropWhile

  • dropWhile<TValue>(array: List<TValue>, predicate?: ListIterator<TValue, boolean>, thisArg?: any): TValue[]
  • dropWhile<TValue>(array: List<TValue>, predicate?: string, thisArg?: any): TValue[]
  • dropWhile<TWhere, TValue>(array: List<TValue>, predicate?: TWhere): TValue[]
  • Creates a slice of array excluding elements dropped from the beginning. Elements are dropped until predicate returns falsey. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>

      The array to query.

    • Optional predicate: ListIterator<TValue, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns TValue[]

    Returns the slice of array.

  • see

    _.dropWhile

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: string
    • Optional thisArg: any

    Returns TValue[]

  • see

    _.dropWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: TWhere

    Returns TValue[]

each

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    • collection: T[]
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns T[]

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns List<T>

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArgs: any

    Returns T

  • see

    _.forEach

    Type parameters

    • T: object

    • TValue

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<TValue, any>
    • Optional thisArgs: any

    Returns T

eachRight

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    • collection: T[]
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns T[]

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns List<T>

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.forEachRight

    Type parameters

    • T: object

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArgs: any

    Returns T

  • see

    _.forEachRight

    Type parameters

    • T: object

    • TValue

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<TValue, any>
    • Optional thisArgs: any

    Returns T

endsWith

  • endsWith(string?: string, target?: string, position?: number): boolean
  • Checks if string ends with the given target string.

    Parameters

    • Optional string: string

      The string to search.

    • Optional target: string

      The string to search for.

    • Optional position: number

      The position to search from.

    Returns boolean

    Returns true if string ends with target, else false.

eq

  • eq(value: any, other: any): boolean
  • Performs a SameValueZero comparison between two values to determine if they are equivalent.

    static
    memberof

    _

    category

    Lang

    example

    var object = { 'user': 'fred' }; var other = { 'user': 'fred' };

    _.eq(object, object); // => true

    _.eq(object, other); // => false

    _.eq('a', 'a'); // => true

    _.eq('a', Object('a')); // => false

    _.eq(NaN, NaN); // => true

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if the values are equivalent, else false.

escape

  • escape(string?: string): string
  • Converts the characters "&", "<", ">", '"', "'", and "`" in string to their corresponding HTML entities.

    Note: No other characters are escaped. To escape additional characters use a third-party library like he.

    hough the ">" character is escaped for symmetry, characters like ">" and "/" don’t need escaping in HTML and have no special meaning unless they're part of a tag or unquoted attribute value. See Mathias Bynens’s article (under "semi-related fun fact") for more details.

    Backticks are escaped because in IE < 9, they can break out of attribute values or HTML comments. See #59,

    #102, #108, and #133 of the HTML5 Security Cheatsheet for more details.

    When working with HTML you should always quote attribute values to reduce XSS vectors.

    Parameters

    • Optional string: string

      The string to escape.

    Returns string

    Returns the escaped string.

escapeRegExp

  • escapeRegExp(string?: string): string
  • Escapes the RegExp special characters "^", "$", "\", ".", "*", "+", "?", "(", ")", "[", "]", "{", "}", and "|" in string.

    Parameters

    • Optional string: string

      The string to escape.

    Returns string

    Returns the escaped string.

every

  • Checks if predicate returns truthy for all elements of collection. Iteration is stopped once predicate returns falsey. The predicate is invoked with three arguments: (value, index|key, collection).

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    Returns boolean

    Returns true if all elements pass the predicate check, else false.

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.every

    Type parameters

    • TObject: object

    • T

    Parameters

    Returns boolean

extend

  • extend<TObject, TSource, TResult>(object: TObject, source: TSource, customizer?: AssignCustomizer, thisArg?: any): TResult
  • extend<TObject, TSource1, TSource2, TResult>(object: TObject, source1: TSource1, source2: TSource2, customizer?: AssignCustomizer, thisArg?: any): TResult
  • extend<TObject, TSource1, TSource2, TSource3, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer?: AssignCustomizer, thisArg?: any): TResult
  • extend<TObject, TSource1, TSource2, TSource3, TSource4, TResult>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer?: AssignCustomizer, thisArg?: any): TResult
  • extend<TObject>(object: TObject): TObject
  • extend<TObject, TResult>(object: TObject, ...otherArgs: any[]): TResult
  • see

    assign

    Type parameters

    • TObject: object

    • TSource: object

    • TResult: object

    Parameters

    • object: TObject
    • source: TSource
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns TResult

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns TResult

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns TResult

  • see

    assign

    Type parameters

    • TObject: object

    • TSource1: object

    • TSource2: object

    • TSource3: object

    • TSource4: object

    • TResult: object

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • Optional customizer: AssignCustomizer
    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • TObject: object

    Parameters

    • object: TObject

    Returns TObject

  • see

    _.assign

    Type parameters

    • TObject: object

    • TResult: object

    Parameters

    • object: TObject
    • Rest ...otherArgs: any[]

    Returns TResult

fill

  • fill<T>(array: any[], value: T, start?: number, end?: number): T[]
  • fill<T>(array: List<any>, value: T, start?: number, end?: number): List<T>
  • Fills elements of array with value from start up to, but not including, end.

    Note: This method mutates array.

    Type parameters

    • T

    Parameters

    • array: any[]

      The array to fill.

    • value: T

      The value to fill array with.

    • Optional start: number

      The start position.

    • Optional end: number

      The end position.

    Returns T[]

    Returns array.

  • see

    _.fill

    Type parameters

    • T

    Parameters

    • array: List<any>
    • value: T
    • Optional start: number
    • Optional end: number

    Returns List<T>

filter

  • filter<T>(collection: List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): T[]
  • filter<T>(collection: Dictionary<T>, predicate?: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • filter(collection: string, predicate?: StringIterator<boolean>, thisArg?: any): string[]
  • filter<T>(collection: List<T> | Dictionary<T>, predicate: string, thisArg?: any): T[]
  • filter<W, T>(collection: List<T> | Dictionary<T>, predicate: W): T[]
  • Iterates over elements of collection, returning an array of all elements predicate returns truthy for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T[]

    Returns the new filtered array.

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Parameters

    • collection: string
    • Optional predicate: StringIterator<boolean>
    • Optional thisArg: any

    Returns string[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>
    • predicate: string
    • Optional thisArg: any

    Returns T[]

  • see

    _.filter

    Type parameters

    • W: object

    • T

    Parameters

    Returns T[]

find

  • Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to search.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T

    Returns the matched element, else undefined.

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>
    • Optional predicate: string
    • Optional thisArg: any

    Returns T

  • see

    _.find

    Type parameters

    • TObject: object

    • T

    Parameters

    Returns T

findIndex

  • findIndex<T>(array: List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): number
  • findIndex<T>(array: List<T>, predicate?: string, thisArg?: any): number
  • findIndex<W, T>(array: List<T>, predicate?: W): number
  • This method is like _.find except that it returns the index of the first element predicate returns truthy for instead of the element itself.

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns number

    Returns the index of the found element, else -1.

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • Optional predicate: W

    Returns number

findKey

  • findKey<TValues, TObject>(object: TObject, predicate?: DictionaryIterator<TValues, boolean>, thisArg?: any): string
  • findKey<TObject>(object: TObject, predicate?: ObjectIterator<any, boolean>, thisArg?: any): string
  • findKey<TObject>(object: TObject, predicate?: string, thisArg?: any): string
  • findKey<TWhere, TObject>(object: TObject, predicate?: TWhere): string
  • This method is like _.find except that it returns the key of the first element predicate returns truthy for instead of the element itself.

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • TValues

    • TObject

    Parameters

    • object: TObject

      The object to search.

    • Optional predicate: DictionaryIterator<TValues, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns string

    Returns the key of the matched element, else undefined.

  • see

    _.findKey

    Type parameters

    • TObject

    Parameters

    • object: TObject
    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns string

  • see

    _.findKey

    Type parameters

    • TObject

    Parameters

    • object: TObject
    • Optional predicate: string
    • Optional thisArg: any

    Returns string

  • see

    _.findKey

    Type parameters

    Parameters

    • object: TObject
    • Optional predicate: TWhere

    Returns string

findLast

  • findLast<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T
  • findLast<W, T>(collection: Array<T>, whereValue: W): T
  • findLast<W, T>(collection: List<T>, whereValue: W): T
  • findLast<W, T>(collection: Dictionary<T>, whereValue: W): T
  • findLast<T>(collection: Array<T>, pluckValue: string): T
  • findLast<T>(collection: List<T>, pluckValue: string): T
  • findLast<T>(collection: Dictionary<T>, pluckValue: string): T
  • This method is like _.find except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      Searches for a value in this list.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T

    The found element, else undefined.

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

findLastIndex

  • findLastIndex<T>(array: List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): number
  • findLastIndex<T>(array: List<T>, predicate?: string, thisArg?: any): number
  • findLastIndex<W, T>(array: List<T>, predicate?: W): number
  • This method is like _.findIndex except that it iterates over elements of collection from right to left.

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The function invoked per iteration.

    Returns number

    Returns the index of the found element, else -1.

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional predicate: string
    • Optional thisArg: any

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • Optional predicate: W

    Returns number

findLastKey

  • findLastKey<TValues, TObject>(object: TObject, predicate?: DictionaryIterator<TValues, boolean>, thisArg?: any): string
  • findLastKey<TObject>(object: TObject, predicate?: ObjectIterator<any, boolean>, thisArg?: any): string
  • findLastKey<TObject>(object: TObject, predicate?: string, thisArg?: any): string
  • findLastKey<TWhere, TObject>(object: TObject, predicate?: TWhere): string
  • This method is like _.findKey except that it iterates over elements of a collection in the opposite order.

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • TValues

    • TObject

    Parameters

    • object: TObject

      The object to search.

    • Optional predicate: DictionaryIterator<TValues, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns string

    Returns the key of the matched element, else undefined.

  • see

    _.findLastKey

    Type parameters

    • TObject

    Parameters

    • object: TObject
    • Optional predicate: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns string

  • see

    _.findLastKey

    Type parameters

    • TObject

    Parameters

    • object: TObject
    • Optional predicate: string
    • Optional thisArg: any

    Returns string

  • see

    _.findLastKey

    Type parameters

    Parameters

    • object: TObject
    • Optional predicate: TWhere

    Returns string

first

  • first<T>(array: List<T>): T
  • see

    _.head

    Type parameters

    • T

    Parameters

    Returns T

flatMap

  • flatMap(array: any[] | List<any>, ...values: any[]): any[]
  • Creates an array of flattened values by running each element in array through iteratee and concating its result to the other mapped values. The iteratee is invoked with three arguments: (value, index|key, array).

    static
    memberof

    _

    category

    Array

    example

    function duplicate(n) { return [n, n]; }

    _.flatMap([1, 2], duplicate); // => [1, 1, 2, 2]

    Parameters

    • array: any[] | List<any>

      The array to iterate over.

    • Rest ...values: any[]

    Returns any[]

    Returns the new array.

flatten

  • Flattens a nested array. If isDeep is true the array is recursively flattened, otherwise it’s only flattened a single level.

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the new flattened array.

  • see

    _.flatten

    Type parameters

    • T

    Parameters

    • array: List<T | T[]>

    Returns T[]

  • see

    _.flatten

    Type parameters

    • T

    Parameters

    Returns RecursiveArray<T>

flattenDeep

  • Recursively flattens a nested array.

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the new flattened array.

flip

  • flip<T>(func: T): T
  • Creates a function that invokes func with arguments reversed.

    static
    memberof

    _

    category

    Function

    example

    var flipped = .flip(function() { return .toArray(arguments); });

    flipped('a', 'b', 'c', 'd'); // => ['d', 'c', 'b', 'a']

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to flip arguments for.

    Returns T

    Returns the new function.

floor

  • floor(n: number, precision?: number): number
  • Calculates n rounded down to precision.

    Parameters

    • n: number

      The number to round down.

    • Optional precision: number

      The precision to round down to.

    Returns number

    Returns the rounded down number.

flow

  • flow<TResult>(...funcs: Function[]): TResult
  • Creates a function that returns the result of invoking the provided functions with the this binding of the created function, where each successive invocation is supplied the return value of the previous.

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

      Functions to invoke.

    Returns TResult

    Returns the new function.

flowRight

  • flowRight<TResult>(...funcs: Function[]): TResult
  • This method is like _.flow except that it creates a function that invokes the provided functions from right to left.

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

      Functions to invoke.

    Returns TResult

    Returns the new function.

forEach

  • Iterates over elements of collection invoking iteratee for each element. The iteratee is bound to thisArg and invoked with three arguments: (value, index|key, collection). Iteratee functions may exit iteration early by explicitly returning false.

    Note: As with other "Collections" methods, objects with a "length" property are iterated like arrays. To avoid this behavior .forIn or .forOwn may be used for object iteration.

    alias

    _.each

    Type parameters

    • T

    Parameters

    • collection: T[]

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns T[]

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns List<T>

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArgs: any

    Returns T

  • see

    _.forEach

    Type parameters

    • T: object

    • TValue

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<TValue, any>
    • Optional thisArgs: any

    Returns T

forEachRight

  • This method is like _.forEach except that it iterates over elements of collection from right to left.

    alias

    _.eachRight

    Type parameters

    • T

    Parameters

    • collection: T[]

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, any>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T[]

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns List<T>

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.forEachRight

    Type parameters

    • T: object

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArgs: any

    Returns T

  • see

    _.forEachRight

    Type parameters

    • T: object

    • TValue

    Parameters

    • collection: T
    • Optional iteratee: ObjectIterator<TValue, any>
    • Optional thisArgs: any

    Returns T

forIn

  • Iterates over own and inherited enumerable properties of an object invoking iteratee for each property. The iteratee is bound to thisArg and invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional iteratee: DictionaryIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns object.

  • see

    _.forIn

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArg: any

    Returns T

forInRight

  • This method is like _.forIn except that it iterates over properties of object in the opposite order.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional iteratee: DictionaryIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns object.

  • see

    _.forInRight

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArg: any

    Returns T

forOwn

  • Iterates over own enumerable properties of an object invoking iteratee for each property. The iteratee is bound to thisArg and invoked with three arguments: (value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional iteratee: DictionaryIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns object.

  • see

    _.forOwn

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArg: any

    Returns T

forOwnRight

  • This method is like _.forOwn except that it iterates over properties of object in the opposite order.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional iteratee: DictionaryIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns object.

  • see

    _.forOwnRight

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional iteratee: ObjectIterator<any, any>
    • Optional thisArg: any

    Returns T

fromPairs

  • fromPairs(array: any[] | List<any>): any[]
  • The inverse of _.toPairs; this method returns an object composed from key-value pairs.

    static
    memberof

    _

    category

    Array

    example

    _.fromPairs([['fred', 30], ['barney', 40]]); // => { 'fred': 30, 'barney': 40 }

    Parameters

    • array: any[] | List<any>

    Returns any[]

    Returns the new object.

functions

  • functions<T>(object: any): string[]
  • Creates an array of function property names from own enumerable properties of object.

    static
    memberof

    _

    category

    Object

    example

    function Foo() { this.a = .constant('a'); this.b = .constant('b'); }

    Foo.prototype.c = _.constant('c');

    _.functions(new Foo); // => ['a', 'b']

    Type parameters

    • T: object

    Parameters

    • object: any

      The object to inspect.

    Returns string[]

    Returns the new array of property names.

functionsIn

  • functionsIn<T>(object: any): string[]
  • Creates an array of function property names from own and inherited enumerable properties of object.

    static
    memberof

    _

    category

    Object

    example

    function Foo() { this.a = .constant('a'); this.b = .constant('b'); }

    Foo.prototype.c = _.constant('c');

    _.functionsIn(new Foo); // => ['a', 'b', 'c']

    Type parameters

    • T: object

    Parameters

    • object: any

      The object to inspect.

    Returns string[]

    Returns the new array of property names.

get

  • get<TResult>(object: Object, path: string | number | boolean | Array<string | number | boolean>, defaultValue?: TResult): TResult
  • Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.

    Type parameters

    • TResult

    Parameters

    • object: Object

      The object to query.

    • path: string | number | boolean | Array<string | number | boolean>

      The path of the property to get.

    • Optional defaultValue: TResult

      The value returned if the resolved value is undefined.

    Returns TResult

    Returns the resolved value.

groupBy

  • Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is an array of the elements responsible for generating the key. The iteratee is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for iteratee the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for iteratee the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TKey

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, TKey>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T[]>

    Returns the composed aggregate object.

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • collection: List<any>
    • Optional iteratee: ListIterator<T, any>
    • Optional thisArg: any

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    • TKey

    Parameters

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    • TValue

    Parameters

    • collection: List<T> | Dictionary<T>
    • Optional iteratee: string
    • Optional thisArg: TValue

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>
    • Optional iteratee: string
    • Optional thisArg: any

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • TWhere

    • T

    Parameters

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T[]>

gt

  • gt(value: any, other: any): boolean
  • Checks if value is greater than other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is greater than other, else false.

gte

  • gte(value: any, other: any): boolean
  • Checks if value is greater than or equal to other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is greater than or equal to other, else false.

has

  • Checks if path is a direct property of object.

    static
    memberof

    _

    category

    Object

    example

    var object = { 'a': { 'b': { 'c': 3 } } }; var other = .create({ 'a': .create({ 'b': _.create({ 'c': 3 }) }) });

    _.has(object, 'a'); // => true

    _.has(object, 'a.b.c'); // => true

    _.has(object, ['a', 'b', 'c']); // => true

    _.has(other, 'a'); // => false

    Type parameters

    • T: object

    Parameters

    Returns boolean

    Returns true if path exists, else false.

hasIn

  • Checks if path is a direct or inherited property of object.

    static
    memberof

    _

    category

    Object

    example

    var object = .create({ 'a': .create({ 'b': _.create({ 'c': 3 }) }) });

    _.hasIn(object, 'a'); // => true

    _.hasIn(object, 'a.b.c'); // => true

    _.hasIn(object, ['a', 'b', 'c']); // => true

    _.hasIn(object, 'b'); // => false

    Type parameters

    • T: object

    Parameters

    Returns boolean

    Returns true if path exists, else false.

head

  • head<T>(array: List<T>): T
  • Gets the first element of array.

    alias

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    Returns T

    Returns the first element of array.

identity

  • identity<T>(value?: T): T
  • This method returns the first argument provided to it.

    Type parameters

    • T

    Parameters

    • Optional value: T

      Any value.

    Returns T

    Returns value.

inRange

  • inRange(n: number, start: number, end: number): boolean
  • inRange(n: number, end: number): boolean
  • Checks if n is between start and up to but not including, end. If end is not specified it’s set to start with start then set to 0.

    Parameters

    • n: number

      The number to check.

    • start: number

      The start of the range.

    • end: number

      The end of the range.

    Returns boolean

    Returns true if n is in the range, else false.

  • see

    _.inRange

    Parameters

    • n: number
    • end: number

    Returns boolean

includes

  • includes<T>(collection: List<T> | Dictionary<T>, target: T, fromIndex?: number): boolean
  • includes(collection: string, target: string, fromIndex?: number): boolean
  • Checks if target is in collection using SameValueZero for equality comparisons. If fromIndex is negative, it’s used as the offset from the end of collection.

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>

      The collection to search.

    • target: T

      The value to search for.

    • Optional fromIndex: number

      The index to search from.

    Returns boolean

    True if the target element is found, else false.

  • see

    _.includes

    Parameters

    • collection: string
    • target: string
    • Optional fromIndex: number

    Returns boolean

indexOf

  • indexOf<T>(array: List<T>, value: T, fromIndex?: boolean | number): number
  • Gets the index at which the first occurrence of value is found in array using SameValueZero for equality comparisons. If fromIndex is negative, it's used as the offset from the end of array. If array is sorted providing true for fromIndex performs a faster binary search.

    static
    memberof

    _

    category

    Array

    example

    _.indexOf([1, 2, 1, 2], 2); // => 1

    // using fromIndex _.indexOf([1, 2, 1, 2], 2, 2); // => 3

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search.

    • value: T

      The value to search for.

    • Optional fromIndex: boolean | number

    Returns number

    Returns the index of the matched value, else -1.

initial

  • initial<T>(array: List<T>): T[]
  • Gets all but the last element of array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    Returns T[]

    Returns the slice of array.

intersection

  • intersection<T>(...arrays: Array<T> | List<T>): T[]
  • Creates an array of unique values that are included in all of the provided arrays using SameValueZero for equality comparisons.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: Array<T> | List<T>

      The arrays to inspect.

    Returns T[]

    Returns the new array of shared values.

intersectionBy

  • intersectionBy(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.intersection except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Array

    example

    _.intersectionBy([2.1, 1.2], [4.3, 2.4], Math.floor); // => [2.1]

    // using the _.property iteratee shorthand _.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 1 }]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns the new array of shared values.

intersectionWith

  • intersectionWith(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.intersection except that it accepts comparator which is invoked to compare elements of arrays. The comparator is invoked with two arguments: (arrVal, othVal).

    static
    memberof

    _

    category

    Array

    example

    var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

    .intersectionWith(objects, others, .isEqual); // => [{ 'x': 1, 'y': 2 }]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns the new array of shared values.

invert

  • invert<T, TResult>(object: T, multiValue?: boolean): TResult
  • invert<TResult>(object: Object, multiValue?: boolean): TResult
  • Creates an object composed of the inverted keys and values of object. If object contains duplicate values, subsequent values overwrite property assignments of previous values unless multiValue is true.

    Type parameters

    • T: object

    • TResult: object

    Parameters

    • object: T

      The object to invert.

    • Optional multiValue: boolean

      Allow multiple values per key.

    Returns TResult

    Returns the new inverted object.

  • see

    _.invert

    Type parameters

    • TResult: object

    Parameters

    • object: Object
    • Optional multiValue: boolean

    Returns TResult

invokeMap

  • invokeMap<TValue, TResult>(collection: TValue[], methodName: string, ...args: any[]): TResult[]
  • invokeMap<TValue, TResult>(collection: Dictionary<TValue>, methodName: string, ...args: any[]): TResult[]
  • invokeMap<TResult>(collection: object[], methodName: string, ...args: any[]): TResult[]
  • invokeMap<TResult>(collection: Dictionary<object>, methodName: string, ...args: any[]): TResult[]
  • invokeMap<TValue, TResult>(collection: TValue[], method: function, ...args: any[]): TResult[]
  • invokeMap<TValue, TResult>(collection: Dictionary<TValue>, method: function, ...args: any[]): TResult[]
  • invokeMap<TResult>(collection: object[], method: function, ...args: any[]): TResult[]
  • invokeMap<TResult>(collection: Dictionary<object>, method: function, ...args: any[]): TResult[]
  • Invokes the method named by methodName on each element in the collection returning an array of the results of each invoked method. Additional arguments will be provided to each invoked method. If methodName is a function it will be invoked for, and this bound to, each element in the collection.

    Type parameters

    • TValue: object

    • TResult

    Parameters

    • collection: TValue[]

      The collection to iterate over.

    • methodName: string

      The name of the method to invoke.

    • Rest ...args: any[]

      Arguments to invoke the method with.

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TValue: object

    • TResult

    Parameters

    • collection: Dictionary<TValue>
    • methodName: string
    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • collection: object[]
    • methodName: string
    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • collection: Dictionary<object>
    • methodName: string
    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TValue: object

    • TResult

    Parameters

    • collection: TValue[]
    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TValue: object

    • TResult

    Parameters

    • collection: Dictionary<TValue>
    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • collection: object[]
    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns TResult[]

  • see

    _.invokeMap

    Type parameters

    • TResult

    Parameters

    • collection: Dictionary<object>
    • method: function
        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    • Rest ...args: any[]

    Returns TResult[]

isArguments

  • isArguments(value?: any): boolean
  • Checks if value is classified as an arguments object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isArray

  • isArray<T>(value?: any): boolean
  • Checks if value is classified as an Array object.

    Type parameters

    • T

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isArrayLike

  • isArrayLike<T>(value?: any): boolean
  • Checks if value is array-like. A value is considered array-like if it's not a function and has a value.length that's an integer greater than or equal to 0 and less than or equal to Number.MAX_SAFE_INTEGER.

    static
    memberof

    _

    type

    Function

    category

    Lang

    example

    _.isArrayLike([1, 2, 3]); // => true

    _.isArrayLike(document.body.children); // => true

    _.isArrayLike('abc'); // => true

    .isArrayLike(.noop); // => false

    Type parameters

    • T

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is array-like, else false.

isArrayLikeObject

  • isArrayLikeObject<T>(value?: any): boolean
  • This method is like _.isArrayLike except that it also checks if value is an object.

    static
    memberof

    _

    type

    Function

    category

    Lang

    example

    _.isArrayLikeObject([1, 2, 3]); // => true

    _.isArrayLikeObject(document.body.children); // => true

    _.isArrayLikeObject('abc'); // => false

    .isArrayLikeObject(.noop); // => false

    Type parameters

    • T

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is an array-like object, else false.

isBoolean

  • isBoolean(value?: any): boolean
  • Checks if value is classified as a boolean primitive or object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isDate

  • isDate(value?: any): boolean
  • Checks if value is classified as a Date object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isElement

  • isElement(value?: any): boolean
  • Checks if value is a DOM element.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a DOM element, else false.

isEmpty

  • isEmpty(value?: any): boolean
  • Checks if value is empty. A value is considered empty unless it’s an arguments object, array, string, or jQuery-like collection with a length greater than 0 or an object with own enumerable properties.

    Parameters

    • Optional value: any

      The value to inspect.

    Returns boolean

    Returns true if value is empty, else false.

isEqual

  • isEqual(value: any, other: any): boolean
  • Performs a deep comparison between two values to determine if they are equivalent.

    Note: This method supports comparing arrays, array buffers, booleans, date objects, error objects, maps, numbers, Object objects, regexes, sets, strings, symbols, and typed arrays. Object objects are compared by their own, not inherited, enumerable properties. Functions and DOM nodes are not supported.

    static
    memberof

    _

    category

    Lang

    example

    var object = { 'user': 'fred' }; var other = { 'user': 'fred' };

    _.isEqual(object, other); // => true

    object === other; // => false

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if the values are equivalent, else false.

isEqualWith

  • This method is like _.isEqual except that it accepts customizer which is invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is invoked with up to seven arguments: (objValue, othValue [, index|key, object, other, stack]).

    static
    memberof

    _

    category

    Lang

    example

    function isGreeting(value) { return /^h(?:i|ello)$/.test(value); }

    function customizer(objValue, othValue) { if (isGreeting(objValue) && isGreeting(othValue)) { return true; } }

    var array = ['hello', 'goodbye']; var other = ['hi', 'goodbye'];

    _.isEqualWith(array, other, customizer); // => true

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    • customizer: IsEqualCustomizer

    Returns boolean

    Returns true if the values are equivalent, else false.

isError

  • isError(value: any): boolean
  • Checks if value is an Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, or URIError object.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is an error object, else false.

isFinite

  • isFinite(value?: any): boolean
  • Checks if value is a finite primitive number.

    Note: This method is based on Number.isFinite.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a finite number, else false.

isFunction

  • isFunction(value?: any): boolean
  • Checks if value is classified as a Function object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isInteger

  • isInteger(value?: any): boolean
  • Checks if value is an integer.

    Note: This method is based on Number.isInteger.

    static
    memberof

    _

    category

    Lang

    example

    _.isInteger(3); // => true

    _.isInteger(Number.MIN_VALUE); // => false

    _.isInteger(Infinity); // => false

    _.isInteger('3'); // => false

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is an integer, else false.

isLength

  • isLength(value?: any): boolean
  • Checks if value is a valid array-like length.

    Note: This function is loosely based on ToLength.

    static
    memberof

    _

    category

    Lang

    example

    _.isLength(3); // => true

    _.isLength(Number.MIN_VALUE); // => false

    _.isLength(Infinity); // => false

    _.isLength('3'); // => false

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a valid length, else false.

isMatch

  • isMatch(object: Object, source: Object): boolean
  • Performs a deep comparison between object and source to determine if object contains equivalent property values.

    Note: This method supports comparing the same values as _.isEqual.

    static
    memberof

    _

    category

    Lang

    example

    var object = { 'user': 'fred', 'age': 40 };

    _.isMatch(object, { 'age': 40 }); // => true

    _.isMatch(object, { 'age': 36 }); // => false

    Parameters

    • object: Object

      The object to inspect.

    • source: Object

      The object of property values to match.

    Returns boolean

    Returns true if object is a match, else false.

isMatchWith

  • This method is like _.isMatch except that it accepts customizer which is invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is invoked with three arguments: (objValue, srcValue, index|key, object, source).

    static
    memberof

    _

    category

    Lang

    example

    function isGreeting(value) { return /^h(?:i|ello)$/.test(value); }

    function customizer(objValue, srcValue) { if (isGreeting(objValue) && isGreeting(srcValue)) { return true; } }

    var object = { 'greeting': 'hello' }; var source = { 'greeting': 'hi' };

    _.isMatchWith(object, source, customizer); // => true

    Parameters

    • object: Object

      The object to inspect.

    • source: Object

      The object of property values to match.

    • customizer: isMatchWithCustomizer

    Returns boolean

    Returns true if object is a match, else false.

isNaN

  • isNaN(value?: any): boolean
  • Checks if value is NaN.

    Note: This method is not the same as isNaN which returns true for undefined and other non-numeric values.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is NaN, else false.

isNative

  • isNative(value: any): boolean
  • Checks if value is a native function.

    retrun

    Returns true if value is a native function, else false.

    Parameters

    • value: any

      The value to check.

    Returns boolean

isNil

  • isNil(value?: any): boolean
  • Checks if value is null or undefined.

    static
    memberof

    _

    category

    Lang

    example

    _.isNil(null); // => true

    _.isNil(void 0); // => true

    _.isNil(NaN); // => false

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is nullish, else false.

isNull

  • isNull(value?: any): boolean
  • Checks if value is null.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is null, else false.

isNumber

  • isNumber(value?: any): boolean
  • Checks if value is classified as a Number primitive or object.

    Note: To exclude Infinity, -Infinity, and NaN, which are classified as numbers, use the _.isFinite method.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isObject

  • isObject(value?: any): boolean
  • Checks if value is the language type of Object. (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is an object, else false.

isObjectLike

  • isObjectLike(value?: any): boolean
  • Checks if value is object-like. A value is object-like if it's not null and has a typeof result of "object".

    static
    memberof

    _

    category

    Lang

    example

    _.isObjectLike({}); // => true

    _.isObjectLike([1, 2, 3]); // => true

    .isObjectLike(.noop); // => false

    _.isObjectLike(null); // => false

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is object-like, else false.

isPlainObject

  • isPlainObject(value?: any): boolean
  • Checks if value is a plain object, that is, an object created by the Object constructor or one with a [[Prototype]] of null.

    Note: This method assumes objects created by the Object constructor have no inherited enumerable properties.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a plain object, else false.

isRegExp

  • isRegExp(value?: any): boolean
  • Checks if value is classified as a RegExp object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isSafeInteger

  • isSafeInteger(value: any): boolean
  • Checks if value is a safe integer. An integer is safe if it's an IEEE-754 double precision number which isn't the result of a rounded unsafe integer.

    Note: This method is based on Number.isSafeInteger.

    static
    memberof

    _

    category

    Lang

    example

    _.isSafeInteger(3); // => true

    _.isSafeInteger(Number.MIN_VALUE); // => false

    _.isSafeInteger(Infinity); // => false

    _.isSafeInteger('3'); // => false

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is a safe integer, else false.

isString

  • isString(value?: any): boolean
  • Checks if value is classified as a String primitive or object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isSymbol

  • isSymbol(value: any): boolean
  • Checks if value is classified as a Symbol primitive or object.

    static
    memberof

    _

    category

    Lang

    example

    _.isSymbol(Symbol.iterator); // => true

    _.isSymbol('abc'); // => false

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isTypedArray

  • isTypedArray(value: any): boolean
  • Checks if value is classified as a typed array.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isUndefined

  • isUndefined(value: any): boolean
  • Checks if value is undefined.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is undefined, else false.

iteratee

  • iteratee<TResult>(func: Function, thisArg?: any): function
  • iteratee<TResult>(func: string, thisArg?: any): function
  • iteratee(func: Object, thisArg?: any): function
  • iteratee<TResult>(): function
  • Creates a function that invokes func with the arguments of the created function. If func is a property name the created callback returns the property value for a given element. If func is an object the created callback returns true for elements that contain the equivalent object properties, otherwise it returns false.

    static
    memberof

    _

    category

    Util

    example

    var users = [ { 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 } ];

    // create custom iteratee shorthands .iteratee = .wrap(_.iteratee, function(callback, func) { var p = /^(\S+)\s([<>])\s(\S+)$/.exec(func); return !p ? callback(func) : function(object) { return (p[2] == '>' ? object[p[1]] > p[3] : object[p[1]] < p[3]); }; });

    _.filter(users, 'age > 36'); // => [{ 'user': 'fred', 'age': 40 }]

    Type parameters

    • TResult

    Parameters

    • func: Function
    • Optional thisArg: any

    Returns function

    Returns the callback.

      • (...args: any[]): TResult
      • Parameters

        • Rest ...args: any[]

        Returns TResult

  • see

    _.iteratee

    Type parameters

    • TResult

    Parameters

    • func: string
    • Optional thisArg: any

    Returns function

      • (object: any): TResult
      • Parameters

        • object: any

        Returns TResult

  • see

    _.iteratee

    Parameters

    • func: Object
    • Optional thisArg: any

    Returns function

      • (object: any): boolean
      • Parameters

        • object: any

        Returns boolean

  • see

    _.iteratee

    Type parameters

    • TResult

    Returns function

      • (value: TResult): TResult
      • Parameters

        • value: TResult

        Returns TResult

join

  • join(array: List<any>, separator?: string): string
  • Converts all elements in array into a string separated by separator.

    Parameters

    • array: List<any>

      The array to convert.

    • Optional separator: string

      The element separator.

    Returns string

    Returns the joined string.

kebabCase

  • kebabCase(string?: string): string
  • Converts string to kebab case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the kebab cased string.

keyBy

  • Creates an object composed of keys generated from the results of running each element of collection through iteratee. The corresponding value of each key is the last element responsible for generating the key. The iteratee function is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for iteratee the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for iteratee the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, any>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns the composed aggregate object.

  • see

    _.keyBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.keyBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.keyBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.keyBy

    Type parameters

    • W: Object

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.keyBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

keys

  • keys(object?: any): string[]
  • Creates an array of the own enumerable property names of object.

    Note: Non-object values are coerced to objects. See the ES spec for more details.

    Parameters

    • Optional object: any

      The object to query.

    Returns string[]

    Returns the array of property names.

keysIn

  • keysIn(object?: any): string[]
  • Creates an array of the own and inherited enumerable property names of object.

    Note: Non-object values are coerced to objects.

    Parameters

    • Optional object: any

      The object to query.

    Returns string[]

    An array of property names.

last

  • last<T>(array: List<T>): T
  • Gets the last element of array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    Returns T

    Returns the last element of array.

lastIndexOf

  • lastIndexOf<T>(array: List<T>, value: T, fromIndex?: boolean | number): number
  • This method is like _.indexOf except that it iterates over elements of array from right to left.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search.

    • value: T

      The value to search for.

    • Optional fromIndex: boolean | number

      The index to search from or true to perform a binary search on a sorted array.

    Returns number

    Returns the index of the matched value, else -1.

lowerCase

  • lowerCase(string?: string): string
  • Converts string, as space separated words, to lower case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the lower cased string.

lowerFirst

  • lowerFirst(string?: string): string
  • Converts the first character of string to lower case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the converted string.

lt

  • lt(value: any, other: any): boolean
  • Checks if value is less than other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is less than other, else false.

lte

  • lte(value: any, other: any): boolean
  • Checks if value is less than or equal to other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is less than or equal to other, else false.

map

  • map<T, TResult>(collection: List<T>, iteratee?: ListIterator<T, TResult>, thisArg?: any): TResult[]
  • map<T, TResult>(collection: Dictionary<T>, iteratee?: DictionaryIterator<T, TResult>, thisArg?: any): TResult[]
  • map<T, TResult>(collection: List<T> | Dictionary<T>, iteratee?: string): TResult[]
  • map<T, TObject>(collection: List<T> | Dictionary<T>, iteratee?: TObject): boolean[]
  • Creates an array of values by running each element in collection through iteratee. The iteratee is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for iteratee the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for iteratee the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Many lodash methods are guarded to work as iteratees for methods like .every, .filter, .map, .mapValues, .reject, and .some.

    The guarded methods are: ary, callback, chunk, clone, create, curry, curryRight, drop, dropRight, every, fill, flatten, invert, max, min, parseInt, slice, sortBy, take, takeRight, template, trim, trimLeft, trimRight, trunc, random, range, sample, some, sum, uniq, and words

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, TResult>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns TResult[]

    Returns the new mapped array.

  • see

    _.map

    Type parameters

    • T: object

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TObject: object

    Parameters

    Returns boolean[]

mapKeys

  • The opposite of _.mapValues; this method creates an object with the same values as object and keys generated by running each own enumerable property of object through iteratee.

    Type parameters

    • T

    • TKey

    Parameters

    • object: List<T>

      The object to iterate over.

    • Optional iteratee: ListIterator<T, TKey>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns Dictionary<T>

    Returns the new mapped object.

  • see

    _.mapKeys

    Type parameters

    • T

    • TKey

    Parameters

    Returns Dictionary<T>

  • see

    _.mapKeys

    Type parameters

    • T

    • TObject: object

    Parameters

    Returns Dictionary<T>

  • see

    _.mapKeys

    Type parameters

    • T

    Parameters

    • object: List<T> | Dictionary<T>
    • Optional iteratee: string
    • Optional thisArg: any

    Returns Dictionary<T>

mapValues

  • Creates an object with the same keys as object and values generated by running each own enumerable property of object through iteratee. The iteratee function is bound to thisArg and invoked with three arguments: (value, key, object).

    If a property name is provided iteratee the created "_.property" style callback returns the property value of the given element.

    If a value is also provided for thisArg the creted "_.matchesProperty" style callback returns true for elements that have a matching property value, else false;.

    If an object is provided for iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TResult

    Parameters

    Returns Dictionary<TResult>

    Returns the new mapped object.

  • Type parameters

    • T

    Parameters

    Returns Dictionary<boolean>

  • Type parameters

    • T

    • TMapped

    Parameters

    • obj: T
    • pluck: string

    Returns TMapped

  • Type parameters

    • T

    Parameters

    Returns T

matches

  • matches<T>(source: T): function
  • matches<T, V>(source: T): function
  • Creates a function that performs a deep comparison between a given object and source, returning true if the given object has equivalent property values, else false.

    Note: This method supports comparing arrays, booleans, Date objects, numbers, Object objects, regexes, and strings. Objects are compared by their own, not inherited, enumerable properties. For comparing a single own or inherited property value see _.matchesProperty.

    Type parameters

    • T

    Parameters

    • source: T

      The object of property values to match.

    Returns function

    Returns the new function.

      • (value: any): boolean
      • Parameters

        • value: any

        Returns boolean

  • see

    _.matches

    Type parameters

    • T

    • V

    Parameters

    • source: T

    Returns function

      • (value: V): boolean
      • Parameters

        • value: V

        Returns boolean

matchesProperty

  • Creates a function that compares the property value of path on a given object to value.

    Note: This method supports comparing arrays, booleans, Date objects, numbers, Object objects, regexes, and strings. Objects are compared by their own, not inherited, enumerable properties.

    Type parameters

    • T

    Parameters

    Returns function

    Returns the new function.

      • (value: any): boolean
      • Parameters

        • value: any

        Returns boolean

  • see

    _.matchesProperty

    Type parameters

    • T

    • V

    Parameters

    Returns function

      • (value: V): boolean
      • Parameters

        • value: V

        Returns boolean

max

  • max<T>(collection: List<T>): T
  • Computes the maximum value of array. If array is empty or falsey undefined is returned.

    static
    memberof

    _

    category

    Math

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T

    Returns the maximum value.

maxBy

  • This method is like _.max except that it accepts iteratee which is invoked for each element in array to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Math

    example

    var objects = [{ 'n': 1 }, { 'n': 2 }];

    _.maxBy(objects, function(o) { return o.a; }); // => { 'n': 2 }

    // using the _.property iteratee shorthand _.maxBy(objects, 'n'); // => { 'n': 2 }

    Type parameters

    • T

    Parameters

    Returns T

    Returns the maximum value.

  • see

    _.maxBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.maxBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.maxBy

    Type parameters

    • TObject: object

    • T

    Parameters

    Returns T

mean

  • mean<T>(collection: List<T>): number
  • Computes the mean of the values in array.

    static
    memberof

    _

    category

    Math

    example

    _.mean([4, 2, 8, 6]); // => 5

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns number

    Returns the mean.

merge

  • merge<TObject, TSource>(object: TObject, source: TSource): TObject & TSource
  • merge<TObject, TSource1, TSource2>(object: TObject, source1: TSource1, source2: TSource2): TObject & TSource1 & TSource2
  • merge<TObject, TSource1, TSource2, TSource3>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3): TObject & TSource1 & TSource2 & TSource3
  • merge<TObject, TSource1, TSource2, TSource3, TSource4>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4): TObject & TSource1 & TSource2 & TSource3 & TSource4
  • merge<TResult>(object: any, ...otherArgs: any[]): TResult
  • Recursively merges own and inherited enumerable properties of source objects into the destination object, skipping source properties that resolve to undefined. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.

    Note: This method mutates object.

    static
    memberof

    _

    category

    Object

    example

    var users = { 'data': [{ 'user': 'barney' }, { 'user': 'fred' }] };

    var ages = { 'data': [{ 'age': 36 }, { 'age': 40 }] };

    _.merge(users, ages); // => { 'data': [{ 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 40 }] }

    Type parameters

    • TObject

    • TSource

    Parameters

    • object: TObject

      The destination object.

    • source: TSource

    Returns TObject & TSource

    Returns object.

  • see

    _.merge

    Type parameters

    • TObject

    • TSource1

    • TSource2

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2

    Returns TObject & TSource1 & TSource2

  • see

    _.merge

    Type parameters

    • TObject

    • TSource1

    • TSource2

    • TSource3

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3

    Returns TObject & TSource1 & TSource2 & TSource3

  • see

    _.merge

    Type parameters

    • TObject

    • TSource1

    • TSource2

    • TSource3

    • TSource4

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4

    Returns TObject & TSource1 & TSource2 & TSource3 & TSource4

  • see

    _.merge

    Type parameters

    • TResult

    Parameters

    • object: any
    • Rest ...otherArgs: any[]

    Returns TResult

mergeWith

  • mergeWith<TObject, TSource>(object: TObject, source: TSource, customizer: MergeWithCustomizer): TObject & TSource
  • mergeWith<TObject, TSource1, TSource2>(object: TObject, source1: TSource1, source2: TSource2, customizer: MergeWithCustomizer): TObject & TSource1 & TSource2
  • mergeWith<TObject, TSource1, TSource2, TSource3>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, customizer: MergeWithCustomizer): TObject & TSource1 & TSource2 & TSource3
  • mergeWith<TObject, TSource1, TSource2, TSource3, TSource4>(object: TObject, source1: TSource1, source2: TSource2, source3: TSource3, source4: TSource4, customizer: MergeWithCustomizer): TObject & TSource1 & TSource2 & TSource3 & TSource4
  • mergeWith<TResult>(object: any, ...otherArgs: any[]): TResult
  • This method is like _.merge except that it accepts customizer which is invoked to produce the merged values of the destination and source properties. If customizer returns undefined merging is handled by the method instead. The customizer is invoked with seven arguments: (objValue, srcValue, key, object, source, stack).

    static
    memberof

    _

    category

    Object

    example

    function customizer(objValue, srcValue) { if (_.isArray(objValue)) { return objValue.concat(srcValue); } }

    var object = { 'fruits': ['apple'], 'vegetables': ['beet'] };

    var other = { 'fruits': ['banana'], 'vegetables': ['carrot'] };

    _.merge(object, other, customizer); // => { 'fruits': ['apple', 'banana'], 'vegetables': ['beet', 'carrot'] }

    Type parameters

    • TObject

    • TSource

    Parameters

    • object: TObject

      The destination object.

    • source: TSource
    • customizer: MergeWithCustomizer

      The function to customize assigned values.

    Returns TObject & TSource

    Returns object.

  • see

    _.mergeWith

    Type parameters

    • TObject

    • TSource1

    • TSource2

    Parameters

    Returns TObject & TSource1 & TSource2

  • see

    _.mergeWith

    Type parameters

    • TObject

    • TSource1

    • TSource2

    • TSource3

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • customizer: MergeWithCustomizer

    Returns TObject & TSource1 & TSource2 & TSource3

  • see

    _.mergeWith

    Type parameters

    • TObject

    • TSource1

    • TSource2

    • TSource3

    • TSource4

    Parameters

    • object: TObject
    • source1: TSource1
    • source2: TSource2
    • source3: TSource3
    • source4: TSource4
    • customizer: MergeWithCustomizer

    Returns TObject & TSource1 & TSource2 & TSource3 & TSource4

  • see

    _.mergeWith

    Type parameters

    • TResult

    Parameters

    • object: any
    • Rest ...otherArgs: any[]

    Returns TResult

method

  • Creates a function that invokes the method at path on a given object. Any additional arguments are provided to the invoked method.

    Type parameters

    • TObject

    • TResult

    Parameters

    • path: string | StringRepresentable[]

      The path of the method to invoke.

    • Rest ...args: any[]

      The arguments to invoke the method with.

    Returns function

    Returns the new function.

      • (object: TObject): TResult
      • Parameters

        • object: TObject

        Returns TResult

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    Returns function

      • (object: any): TResult
      • Parameters

        • object: any

        Returns TResult

methodOf

  • methodOf<TObject, TResult>(object: TObject, ...args: any[]): function
  • methodOf<TResult>(object: object, ...args: any[]): function
  • The opposite of _.method; this method creates a function that invokes the method at a given path on object. Any additional arguments are provided to the invoked method.

    Type parameters

    • TObject: object

    • TResult

    Parameters

    • object: TObject

      The object to query.

    • Rest ...args: any[]

      The arguments to invoke the method with.

    Returns function

    Returns the new function.

  • see

    _.methodOf

    Type parameters

    • TResult

    Parameters

    • object: object
    • Rest ...args: any[]

    Returns function

min

  • min<T>(collection: List<T>): T
  • Computes the minimum value of array. If array is empty or falsey undefined is returned.

    static
    memberof

    _

    category

    Math

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T

    Returns the minimum value.

minBy

  • This method is like _.min except that it accepts iteratee which is invoked for each element in array to generate the criterion by which the value is ranked. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Math

    example

    var objects = [{ 'n': 1 }, { 'n': 2 }];

    _.minBy(objects, function(o) { return o.a; }); // => { 'n': 1 }

    // using the _.property iteratee shorthand _.minBy(objects, 'n'); // => { 'n': 1 }

    Type parameters

    • T

    Parameters

    Returns T

    Returns the minimum value.

  • see

    _.minBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.minBy

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.minBy

    Type parameters

    • TObject: object

    • T

    Parameters

    Returns T

mixin

  • Adds all own enumerable function properties of a source object to the destination object. If object is a function then methods are added to its prototype as well.

    Note: Use _.runInContext to create a pristine lodash function to avoid conflicts caused by modifying the original.

    Type parameters

    • TResult

    • TObject

    Parameters

    • object: TObject

      The destination object.

    • source: Dictionary<Function>

      The object of functions to add.

    • Optional options: MixinOptions

      The options object.

    Returns TResult

    Returns object.

  • see

    _.mixin

    Type parameters

    • TResult

    Parameters

    Returns TResult

negate

  • negate<T>(predicate: T): function
  • negate<T, TResult>(predicate: T): TResult
  • Creates a function that negates the result of the predicate func. The func predicate is invoked with the this binding and arguments of the created function.

    Type parameters

    • T: Function

    Parameters

    • predicate: T

      The predicate to negate.

    Returns function

    Returns the new function.

      • (...args: any[]): boolean
      • Parameters

        • Rest ...args: any[]

        Returns boolean

  • see

    _.negate

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • predicate: T

    Returns TResult

noConflict

  • Reverts the _ variable to its previous value and returns a reference to the lodash function.

    Returns LoDashStatic

    Returns the lodash function.

noop

  • noop(...args: any[]): void
  • A no-operation function that returns undefined regardless of the arguments it receives.

    Parameters

    • Rest ...args: any[]

    Returns void

    undefined

now

  • now(): number
  • Gets the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).

    Returns number

    The number of milliseconds.

nthArg

  • nthArg<TResult>(n?: number): TResult
  • Creates a function that returns its nth argument.

    Type parameters

    • TResult: Function

    Parameters

    • Optional n: number

      The index of the argument to return.

    Returns TResult

    Returns the new function.

omit

  • The opposite of _.pick; this method creates an object composed of the own and inherited enumerable properties of object that are not omitted.

    static
    memberof

    _

    category

    Object

    example

    var object = { 'a': 1, 'b': '2', 'c': 3 };

    _.omit(object, ['a', 'c']); // => { 'b': '2' }

    Type parameters

    • TResult: object

    • T: object

    Parameters

    Returns TResult

    Returns the new object.

omitBy

  • omitBy<TResult, T>(object: T, predicate: ObjectIterator<any, boolean>): TResult
  • The opposite of _.pickBy; this method creates an object composed of the own and inherited enumerable properties of object that predicate doesn't return truthy for.

    static
    memberof

    _

    category

    Object

    example

    var object = { 'a': 1, 'b': '2', 'c': 3 };

    .omitBy(object, .isNumber); // => { 'b': '2' }

    Type parameters

    • TResult: object

    • T: object

    Parameters

    • object: T

      The source object.

    • predicate: ObjectIterator<any, boolean>

    Returns TResult

    Returns the new object.

once

  • once<T>(func: T): T
  • Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first call. The func is invoked with the this binding and arguments of the created function.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to restrict.

    Returns T

    Returns the new restricted function.

orderBy

  • This method is like _.sortBy except that it allows specifying the sort orders of the iteratees to sort by. If orders is unspecified, all values are sorted in ascending order. Otherwise, specify an order of "desc" for descending or "asc" for ascending sort order of corresponding values.

    static
    memberof

    _

    category

    Collection

    example

    var users = [ { 'user': 'fred', 'age': 48 }, { 'user': 'barney', 'age': 34 }, { 'user': 'fred', 'age': 42 }, { 'user': 'barney', 'age': 36 } ];

    // sort by user in ascending order and by age in descending order _.orderBy(users, ['user', 'age'], ['asc', 'desc']); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]

    Type parameters

    • W: Object

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • iteratees: ListIterator<T, any> | string | W | ListIterator<T, any> | string | W
    • Optional orders: boolean | string | boolean | string

    Returns T[]

    Returns the new sorted array.

  • see

    _.orderBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • iteratees: ListIterator<T, any> | string | Object | ListIterator<T, any> | string | Object
    • Optional orders: boolean | string | boolean | string

    Returns T[]

  • see

    _.orderBy

    Type parameters

    • W: Object

    • T

    Parameters

    Returns T[]

  • see

    _.orderBy

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.orderBy

    Type parameters

    • W: Object

    • T

    Parameters

    Returns T[]

  • see

    _.orderBy

    Type parameters

    • T

    Parameters

    Returns T[]

over

  • over<TResult>(...iteratees: Function | Array<Function>): function
  • Creates a function that invokes iteratees with the arguments provided to the created function and returns their results.

    Type parameters

    • TResult

    Parameters

    • Rest ...iteratees: Function | Array<Function>

      The iteratees to invoke.

    Returns function

    Returns the new function.

      • (...args: any[]): TResult[]
      • Parameters

        • Rest ...args: any[]

        Returns TResult[]

overArgs

  • overArgs<T, TResult>(func: T, ...transforms: Function[]): TResult
  • overArgs<T, TResult>(func: T, transforms: Function[]): TResult
  • Creates a function that runs each argument through a corresponding transform function.

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T

      The function to wrap.

    • Rest ...transforms: Function[]

      The functions to transform arguments, specified as individual functions or arrays of functions.

    Returns TResult

    Returns the new function.

  • see

    _.overArgs

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T
    • transforms: Function[]

    Returns TResult

overEvery

  • overEvery(...predicates: Function | Array<Function>): function
  • Creates a function that checks if all of the predicates return truthy when invoked with the arguments provided to the created function.

    Parameters

    • Rest ...predicates: Function | Array<Function>

      The predicates to check.

    Returns function

    Returns the new function.

      • (...args: any[]): boolean
      • Parameters

        • Rest ...args: any[]

        Returns boolean

overSome

  • overSome(...predicates: Function | Array<Function>): function
  • Creates a function that checks if any of the predicates return truthy when invoked with the arguments provided to the created function.

    Parameters

    • Rest ...predicates: Function | Array<Function>

      The predicates to check.

    Returns function

    Returns the new function.

      • (...args: any[]): boolean
      • Parameters

        • Rest ...args: any[]

        Returns boolean

pad

  • pad(string?: string, length?: number, chars?: string): string
  • Pads string on the left and right sides if it’s shorter than length. Padding characters are truncated if they can’t be evenly divided by length.

    Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

padEnd

  • padEnd(string?: string, length?: number, chars?: string): string
  • Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed length.

    Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

padStart

  • padStart(string?: string, length?: number, chars?: string): string
  • Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed length.

    Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

parseInt

  • parseInt(string: string, radix?: number): number
  • Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used.

    Note: This method aligns with the ES5 implementation of parseInt.

    Parameters

    • string: string

      The string to convert.

    • Optional radix: number

      The radix to interpret value by.

    Returns number

    Returns the converted integer.

partition

  • partition<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • partition<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • partition<W, T>(collection: List<T>, whereValue: W): T[]
  • partition<W, T>(collection: Dictionary<T>, whereValue: W): T[]
  • partition<T>(collection: List<T>, path: string, srcValue: any): T[]
  • partition<T>(collection: Dictionary<T>, path: string, srcValue: any): T[]
  • partition<T>(collection: List<T>, pluckValue: string): T[]
  • partition<T>(collection: Dictionary<T>, pluckValue: string): T[]
  • Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, while the second of which contains elements predicate returns falsey for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T[]

    Returns the array of grouped elements.

  • see

    _.partition

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.partition

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T[]

  • see

    _.partition

    Type parameters

    • W

    • T

    Parameters

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • path: string
    • srcValue: any

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • path: string
    • srcValue: any

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    Returns T[]

pick

  • Creates an object composed of the picked object properties.

    static
    memberof

    _

    category

    Object

    example

    var object = { 'a': 1, 'b': '2', 'c': 3 };

    _.pick(object, ['a', 'c']); // => { 'a': 1, 'c': 3 }

    Type parameters

    • TResult: object

    • T: object

    Parameters

    Returns TResult

    Returns the new object.

pickBy

  • pickBy<TResult, T>(object: T, predicate: ObjectIterator<any, boolean>): TResult
  • Creates an object composed of the object properties predicate returns truthy for. The predicate is invoked with one argument: (value).

    static
    memberof

    _

    category

    Object

    example

    var object = { 'a': 1, 'b': '2', 'c': 3 };

    .pickBy(object, .isNumber); // => { 'a': 1, 'c': 3 }

    Type parameters

    • TResult: object

    • T: object

    Parameters

    • object: T

      The source object.

    • predicate: ObjectIterator<any, boolean>

    Returns TResult

    Returns the new object.

property

  • Creates a function that returns the property value at path on a given object.

    Type parameters

    • TObj

    • TResult

    Parameters

    Returns function

    Returns the new function.

      • (obj: TObj): TResult
      • Parameters

        • obj: TObj

        Returns TResult

propertyOf

  • propertyOf<T>(object: T): function
  • The opposite of _.property; this method creates a function that returns the property value at a given path on object.

    Type parameters

    • T: object

    Parameters

    • object: T

      The object to query.

    Returns function

    Returns the new function.

      • (path: string | string[]): any
      • Parameters

        • path: string | string[]

        Returns any

pull

  • pull<T>(array: T[], ...values: T[]): T[]
  • pull<T>(array: List<T>, ...values: T[]): List<T>
  • Removes all provided values from array using SameValueZero for equality comparisons.

    Note: Unlike _.without, this method mutates array.

    Type parameters

    • T

    Parameters

    • array: T[]

      The array to modify.

    • Rest ...values: T[]

      The values to remove.

    Returns T[]

    Returns array.

  • see

    _.pull

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Rest ...values: T[]

    Returns List<T>

pullAll

  • pullAll(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.pull except that it accepts an array of values to remove.

    Note: Unlike _.difference, this method mutates array.

    static
    memberof

    _

    category

    Array

    example

    var array = [1, 2, 3, 1, 2, 3];

    _.pull(array, [2, 3]); console.log(array); // => [1, 1]

    Parameters

    • array: any[] | List<any>

      The array to modify.

    • Rest ...values: any[]

      The values to remove.

    Returns any[]

    Returns array.

pullAllBy

  • pullAllBy(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.pullAll except that it accepts iteratee which is invoked for each element of array and values to to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    Note: Unlike _.differenceBy, this method mutates array.

    static
    memberof

    _

    category

    Array

    example

    var array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }];

    _.pullAllBy(array, [{ 'x': 1 }, { 'x': 3 }], 'x'); console.log(array); // => [{ 'x': 2 }]

    Parameters

    • array: any[] | List<any>

      The array to modify.

    • Rest ...values: any[]

      The values to remove.

    Returns any[]

    Returns array.

pullAt

  • pullAt<T>(array: List<T>, ...indexes: number | Array<number>): T[]
  • Removes elements from array corresponding to the given indexes and returns an array of the removed elements. Indexes may be specified as an array of indexes or as individual arguments.

    Note: Unlike _.at, this method mutates array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to modify.

    • Rest ...indexes: number | Array<number>

      The indexes of elements to remove, specified as individual indexes or arrays of indexes.

    Returns T[]

    Returns the new array of removed elements.

random

  • random(min?: number, max?: number, floating?: boolean): number
  • random(min?: number, floating?: boolean): number
  • random(floating?: boolean): number
  • Produces a random number between min and max (inclusive). If only one argument is provided a number between 0 and the given number is returned. If floating is true, or either min or max are floats, a floating-point number is returned instead of an integer.

    Parameters

    • Optional min: number

      The minimum possible value.

    • Optional max: number

      The maximum possible value.

    • Optional floating: boolean

      Specify returning a floating-point number.

    Returns number

    Returns the random number.

  • see

    _.random

    Parameters

    • Optional min: number
    • Optional floating: boolean

    Returns number

  • see

    _.random

    Parameters

    • Optional floating: boolean

    Returns number

range

  • range(start: number, end: number, step?: number): number[]
  • range(end: number, step?: number): number[]
  • Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length range is created unless a negative step is specified.

    Parameters

    • start: number

      The start of the range.

    • end: number

      The end of the range.

    • Optional step: number

      The value to increment or decrement by.

    Returns number[]

    Returns a new range array.

  • see

    _.range

    Parameters

    • end: number
    • Optional step: number

    Returns number[]

rangeRight

  • rangeRight(start: number, end: number, step?: number): number[]
  • rangeRight(end: number, step?: number): number[]
  • This method is like _.range except that it populates values in descending order.

    static
    memberof

    _

    category

    Util

    example

    _.rangeRight(4); // => [3, 2, 1, 0]

    _.rangeRight(-4); // => [-3, -2, -1, 0]

    _.rangeRight(1, 5); // => [4, 3, 2, 1]

    _.rangeRight(0, 20, 5); // => [15, 10, 5, 0]

    _.rangeRight(0, -4, -1); // => [-3, -2, -1, 0]

    _.rangeRight(1, 4, 0); // => [1, 1, 1]

    _.rangeRight(0); // => []

    Parameters

    • start: number
    • end: number

      The end of the range.

    • Optional step: number

    Returns number[]

    Returns the new array of numbers.

  • see

    _.rangeRight

    Parameters

    • end: number
    • Optional step: number

    Returns number[]

rearg

  • rearg<TResult>(func: Function, indexes: number[]): TResult
  • rearg<TResult>(func: Function, ...indexes: number[]): TResult
  • Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to rearrange arguments for.

    • indexes: number[]

      The arranged argument indexes, specified as individual indexes or arrays of indexes.

    Returns TResult

    Returns the new function.

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • func: Function
    • Rest ...indexes: number[]

    Returns TResult

reduce

  • reduce<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduce<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not provided the first element of the collection will be used as the initial accumulator value. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, index|key, collection).

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: MemoIterator<T, TResult>

      The function called per iteration.

    • accumulator: TResult

      Initial value of the accumulator.

    • Optional thisArg: any

      The this binding of callback.

    Returns TResult

    Returns the accumulated value.

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

reduceRight

  • reduceRight<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • This method is like _.reduce except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: MemoIterator<T, TResult>

      The function called per iteration.

    • accumulator: TResult

      Initial value of the accumulator.

    • Optional thisArg: any

      The this binding of callback.

    Returns TResult

    The accumulated value.

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

reject

  • reject<T>(collection: List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): T[]
  • reject<T>(collection: Dictionary<T>, predicate?: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • reject(collection: string, predicate?: StringIterator<boolean>, thisArg?: any): string[]
  • reject<T>(collection: List<T> | Dictionary<T>, predicate: string, thisArg?: any): T[]
  • reject<W, T>(collection: List<T> | Dictionary<T>, predicate: W): T[]
  • The opposite of _.filter; this method returns the elements of collection that predicate does not return truthy for.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T[]

    Returns the new filtered array.

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.reject

    Parameters

    • collection: string
    • Optional predicate: StringIterator<boolean>
    • Optional thisArg: any

    Returns string[]

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • collection: List<T> | Dictionary<T>
    • predicate: string
    • Optional thisArg: any

    Returns T[]

  • see

    _.reject

    Type parameters

    • W: object

    • T

    Parameters

    Returns T[]

remove

  • remove<T>(array: List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): T[]
  • remove<T>(array: List<T>, predicate?: string, thisArg?: any): T[]
  • remove<W, T>(array: List<T>, predicate?: W): T[]
  • Removes all elements from array that predicate returns truthy for and returns an array of the removed elements. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Note: Unlike _.filter, this method mutates array.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to modify.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T[]

    Returns the new array of removed elements.

  • see

    _.remove

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional predicate: string
    • Optional thisArg: any

    Returns T[]

  • see

    _.remove

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • Optional predicate: W

    Returns T[]

repeat

  • repeat(string?: string, n?: number): string
  • Repeats the given string n times.

    Parameters

    • Optional string: string

      The string to repeat.

    • Optional n: number

      The number of times to repeat the string.

    Returns string

    Returns the repeated string.

replace

  • replace(string: string, pattern: RegExp | string, replacement: Function | string): string
  • replace(pattern?: RegExp | string, replacement?: Function | string): string
  • Replaces matches for pattern in string with replacement.

    Note: This method is based on String#replace.

    Parameters

    • string: string
    • pattern: RegExp | string
    • replacement: Function | string

    Returns string

    Returns the modified string.

  • see

    _.replace

    Parameters

    • Optional pattern: RegExp | string
    • Optional replacement: Function | string

    Returns string

rest

  • rest<TResult>(func: Function, start?: number): TResult
  • rest<TResult, TFunc>(func: TFunc, start?: number): TResult
  • Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.

    Note: This method is based on the rest parameter.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to apply a rest parameter to.

    • Optional start: number

      The start position of the rest parameter.

    Returns TResult

    Returns the new function.

  • see

    _.rest

    Type parameters

    • TResult: Function

    • TFunc: Function

    Parameters

    • func: TFunc
    • Optional start: number

    Returns TResult

result

  • result<TObject, TResult>(object: TObject, path: number | string | boolean | Array<number | string | boolean>, defaultValue?: TResult): TResult
  • This method is like _.get except that if the resolved value is a function it’s invoked with the this binding of its parent object and its result is returned.

    Type parameters

    • TObject

    • TResult

    Parameters

    • object: TObject

      The object to query.

    • path: number | string | boolean | Array<number | string | boolean>

      The path of the property to resolve.

    • Optional defaultValue: TResult

      The value returned if the resolved value is undefined.

    Returns TResult

    Returns the resolved value.

reverse

  • reverse(array: any[] | List<any>, ...values: any[]): any[]
  • Reverses array so that the first element becomes the last, the second element becomes the second to last, and so on.

    Note: This method mutates array and is based on Array#reverse.

    memberof

    _

    category

    Array

    example

    var array = [1, 2, 3];

    _.reverse(array); // => [3, 2, 1]

    console.log(array); // => [3, 2, 1]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns array.

round

  • round(n: number, precision?: number): number
  • Calculates n rounded to precision.

    Parameters

    • n: number

      The number to round.

    • Optional precision: number

      The precision to round to.

    Returns number

    Returns the rounded number.

runInContext

  • Create a new pristine lodash function using the given context object.

    Parameters

    • Optional context: Object

      The context object.

    Returns LoDashStatic

    Returns a new lodash function.

sample

  • sample<T>(collection: Array<T>): T
  • sample<T>(collection: List<T>): T
  • sample<T>(collection: Dictionary<T>): T
  • Gets a random element from collection.

    static
    memberof

    _

    category

    Collection

    example

    _.sample([1, 2, 3, 4]); // => 2

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to sample.

    Returns T

    Returns the random element.

  • see

    _.sample

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T

  • see

    _.sample

    Type parameters

    • T

    Parameters

    Returns T

sampleSize

  • sampleSize<T>(collection: Array<T>, n: number): T[]
  • sampleSize<T>(collection: List<T>, n: number): T[]
  • sampleSize<T>(collection: Dictionary<T>, n: number): T[]
  • Gets n random elements from collection.

    static
    memberof

    _

    category

    Collection

    example

    _.sampleSize([1, 2, 3, 4], 2); // => [3, 1]

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to sample.

    • n: number

    Returns T[]

    Returns the random elements.

  • see

    _.sampleSize

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • n: number

    Returns T[]

  • see

    _.sampleSize

    Type parameters

    • T

    Parameters

    Returns T[]

set

  • Sets the value at path of object. If a portion of path doesn’t exist it’s created. Arrays are created for missing index properties while objects are created for all other missing properties. Use _.setWith to customize path creation.

    Type parameters

    • TResult

    Parameters

    Returns TResult

    Returns object.

  • see

    _.set

    Type parameters

    • V

    • TResult

    Parameters

    Returns TResult

  • see

    _.set

    Type parameters

    • O

    • V

    • TResult

    Parameters

    Returns TResult

setWith

  • This method is like _.set except that it accepts customizer which is invoked to produce the objects of path. If customizer returns undefined path creation is handled by the method instead. The customizer is invoked with three arguments: (nsValue, key, nsObject).

    parem

    customizer The function to customize assigned values.

    Type parameters

    • TResult

    Parameters

    Returns TResult

    Returns object.

  • see

    _.setWith

    Type parameters

    • V

    • TResult

    Parameters

    Returns TResult

  • see

    _.setWith

    Type parameters

    • O

    • V

    • TResult

    Parameters

    Returns TResult

shuffle

  • shuffle<T>(collection: List<T> | Dictionary<T>): T[]
  • shuffle(collection: string): string[]
  • Creates an array of shuffled values, using a version of the Fisher-Yates shuffle.

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the new shuffled array.

  • see

    _.shuffle

    Parameters

    • collection: string

    Returns string[]

size

  • size<T>(collection: List<T> | Dictionary<T>): number
  • size(collection: string): number
  • Gets the size of collection by returning its length for array-like values or the number of own enumerable properties for objects.

    Type parameters

    • T

    Parameters

    Returns number

    Returns the size of collection.

  • see

    _.size

    Parameters

    • collection: string

    Returns number

slice

  • slice<T>(array: T[], start?: number, end?: number): T[]
  • Creates a slice of array from start up to, but not including, end.

    Type parameters

    • T

    Parameters

    • array: T[]

      The array to slice.

    • Optional start: number

      The start position.

    • Optional end: number

      The end position.

    Returns T[]

    Returns the slice of array.

snakeCase

  • snakeCase(string?: string): string
  • Converts string to snake case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the snake cased string.

some

  • Checks if predicate returns truthy for any element of collection. Iteration is stopped once predicate returns truthy. The predicate is invoked with three arguments: (value, index|key, collection).

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional predicate: ListIterator<T, boolean>

      The function invoked per iteration.

    Returns boolean

    Returns true if any element passes the predicate check, else false.

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.some

    Type parameters

    • TObject: object

    • T

    Parameters

    Returns boolean

sortBy

  • Creates an array of elements, sorted in ascending order by the results of running each element in a collection through each iteratee. This method performs a stable sort, that is, it preserves the original sort order of equal elements. The iteratees are invoked with one argument: (value).

    static
    memberof

    _

    category

    Collection

    example

    var users = [ { 'user': 'fred', 'age': 48 }, { 'user': 'barney', 'age': 36 }, { 'user': 'fred', 'age': 42 }, { 'user': 'barney', 'age': 34 } ];

    _.sortBy(users, function(o) { return o.user; }); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]

    _.sortBy(users, ['user', 'age']); // => objects for [['barney', 34], ['barney', 36], ['fred', 42], ['fred', 48]]

    _.sortBy(users, 'user', function(o) { return Math.floor(o.age / 10); }); // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]

    Type parameters

    • T

    • TSort

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, TSort>

    Returns T[]

    Returns the new sorted array.

  • see

    _.sortBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • W: object

    • T

    Parameters

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T>
    • iteratees: ListIterator<T, any> | string | Object

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T>
    • Rest ...iteratees: ListIterator<T, boolean> | Object | string

    Returns T[]

sortedIndex

  • sortedIndex<T, TSort>(array: List<T>, value: T): number
  • sortedIndex<T>(array: List<T>, value: T): number
  • sortedIndex<T>(array: List<T>, value: T): number
  • sortedIndex<W, T>(array: List<T>, value: T): number
  • sortedIndex<T>(array: List<T>, value: T): number
  • Uses a binary search to determine the lowest index at which value should be inserted into array in order to maintain its sort order.

    static
    memberof

    _

    category

    Array

    example

    _.sortedIndex([30, 50], 40); // => 1

    _.sortedIndex([4, 5], 4); // => 0

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>

      The sorted array to inspect.

    • value: T

      The value to evaluate.

    Returns number

    Returns the index at which value should be inserted into array.

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

sortedIndexBy

  • sortedIndexBy<T, TSort>(array: List<T>, value: T, iteratee: function): number
  • sortedIndexBy<T>(array: List<T>, value: T, iteratee: function): number
  • sortedIndexBy<T>(array: List<T>, value: T, iteratee: string): number
  • sortedIndexBy<W, T>(array: List<T>, value: T, iteratee: W): number
  • sortedIndexBy<T>(array: List<T>, value: T, iteratee: Object): number
  • This method is like _.sortedIndex except that it accepts iteratee which is invoked for value and each element of array to compute their sort ranking. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Array

    example

    var dict = { 'thirty': 30, 'forty': 40, 'fifty': 50 };

    .sortedIndexBy(['thirty', 'fifty'], 'forty', .propertyOf(dict)); // => 1

    // using the _.property iteratee shorthand _.sortedIndexBy([{ 'x': 4 }, { 'x': 5 }], { 'x': 4 }, 'x'); // => 0

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>

      The sorted array to inspect.

    • value: T

      The value to evaluate.

    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

    Returns the index at which value should be inserted into array.

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: W

    Returns number

  • see

    _.sortedIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: Object

    Returns number

sortedIndexOf

  • sortedIndexOf<T>(array: List<T>, value: T): number
  • This method is like _.indexOf except that it performs a binary search on a sorted array.

    static
    memberof

    _

    category

    Array

    example

    _.sortedIndexOf([1, 1, 2, 2], 2); // => 2

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to search.

    • value: T

      The value to search for.

    Returns number

    Returns the index of the matched value, else -1.

sortedLastIndex

  • sortedLastIndex<T, TSort>(array: List<T>, value: T): number
  • sortedLastIndex<T>(array: List<T>, value: T): number
  • sortedLastIndex<T>(array: List<T>, value: T): number
  • sortedLastIndex<W, T>(array: List<T>, value: T): number
  • sortedLastIndex<T>(array: List<T>, value: T): number
  • This method is like _.sortedIndex except that it returns the highest index at which value should be inserted into array in order to maintain its sort order.

    static
    memberof

    _

    category

    Array

    example

    _.sortedLastIndex([4, 5], 4); // => 1

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>

      The sorted array to inspect.

    • value: T

      The value to evaluate.

    Returns number

    Returns the index at which value should be inserted into array.

  • see

    _.sortedLastIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.sortedLastIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

sortedLastIndexBy

  • sortedLastIndexBy<T, TSort>(array: List<T>, value: T, iteratee: function): number
  • sortedLastIndexBy<T>(array: List<T>, value: T, iteratee: function): number
  • sortedLastIndexBy<T>(array: List<T>, value: T, iteratee: string): number
  • sortedLastIndexBy<W, T>(array: List<T>, value: T, iteratee: W): number
  • sortedLastIndexBy<T>(array: List<T>, value: T, iteratee: Object): number
  • This method is like _.sortedLastIndex except that it accepts iteratee which is invoked for value and each element of array to compute their sort ranking. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Array

    example

    // using the _.property iteratee shorthand _.sortedLastIndexBy([{ 'x': 4 }, { 'x': 5 }], { 'x': 4 }, 'x'); // => 1

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>

      The sorted array to inspect.

    • value: T

      The value to evaluate.

    • iteratee: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    Returns number

    Returns the index at which value should be inserted into array.

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: function
        • (x: T): any
        • Parameters

          • x: T

          Returns any

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: string

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: W

    Returns number

  • see

    _.sortedLastIndexBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • iteratee: Object

    Returns number

sortedLastIndexOf

  • sortedLastIndexOf(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.lastIndexOf except that it performs a binary search on a sorted array.

    static
    memberof

    _

    category

    Array

    example

    _.sortedLastIndexOf([1, 1, 2, 2], 2); // => 3

    Parameters

    • array: any[] | List<any>

      The array to search.

    • Rest ...values: any[]

    Returns any[]

    Returns the index of the matched value, else -1.

sortedUniq

  • sortedUniq<T>(array: List<T>): T[]
  • sortedUniq<T, TSort>(array: List<T>): T[]
  • This method is like _.uniq except that it's designed and optimized for sorted arrays.

    static
    memberof

    _

    category

    Array

    example

    _.sortedUniq([1, 1, 2]); // => [1, 2]

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to inspect.

    Returns T[]

    Returns the new duplicate free array.

  • see

    _.sortedUniq

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

sortedUniqBy

  • sortedUniqBy<T>(array: List<T>, iteratee: ListIterator<T, any>): T[]
  • sortedUniqBy<T, TSort>(array: List<T>, iteratee: ListIterator<T, TSort>): T[]
  • sortedUniqBy<T>(array: List<T>, iteratee: string): T[]
  • sortedUniqBy<T>(array: List<T>, iteratee: Object): T[]
  • sortedUniqBy<TWhere, T>(array: List<T>, iteratee: TWhere): T[]
  • This method is like _.uniqBy except that it's designed and optimized for sorted arrays.

    static
    memberof

    _

    category

    Array

    example

    _.sortedUniqBy([1.1, 1.2, 2.3, 2.4], Math.floor); // => [1.1, 2.2]

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the new duplicate free array.

  • see

    _.sortedUniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • iteratee: string

    Returns T[]

  • see

    _.sortedUniqBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • iteratee: Object

    Returns T[]

  • see

    _.sortedUniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • array: List<T>
    • iteratee: TWhere

    Returns T[]

split

  • split(string: string, separator?: RegExp | string, limit?: number): string[]
  • Splits string by separator.

    Note: This method is based on String#split.

    Parameters

    • string: string
    • Optional separator: RegExp | string
    • Optional limit: number

    Returns string[]

    Returns the new array of string segments.

spread

  • spread<F, T>(func: F): T
  • spread<T>(func: Function): T
  • Creates a function that invokes func with the this binding of the created function and an array of arguments much like Function#apply.

    Note: This method is based on the spread operator.

    Type parameters

    • F: Function

    • T: Function

    Parameters

    • func: F

      The function to spread arguments over.

    Returns T

    Returns the new function.

  • see

    _.spread

    Type parameters

    • T: Function

    Parameters

    • func: Function

    Returns T

startCase

  • startCase(string?: string): string
  • Converts string to start case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the start cased string.

startsWith

  • startsWith(string?: string, target?: string, position?: number): boolean
  • Checks if string starts with the given target string.

    Parameters

    • Optional string: string

      The string to search.

    • Optional target: string

      The string to search for.

    • Optional position: number

      The position to search from.

    Returns boolean

    Returns true if string starts with target, else false.

subtract

  • subtract(minuend: number, subtrahend: number): number
  • Subtract two numbers.

    static
    memberof

    _

    category

    Math

    example

    _.subtract(6, 4); // => 2

    Parameters

    • minuend: number

      The first number in a subtraction.

    • subtrahend: number

      The second number in a subtraction.

    Returns number

    Returns the difference.

sum

  • sum<T>(collection: List<T>): number
  • sum(collection: List<number> | Dictionary<number>): number
  • Computes the sum of the values in array.

    static
    memberof

    _

    category

    Math

    example

    _.sum([4, 2, 8, 6]); // => 20

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns number

    Returns the sum.

  • see

    _.sum

    Parameters

    Returns number

sumBy

  • This method is like _.sum except that it accepts iteratee which is invoked for each element in array to generate the value to be summed. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Math

    example

    var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];

    _.sumBy(objects, function(o) { return o.n; }); // => 20

    // using the _.property iteratee shorthand _.sumBy(objects, 'n'); // => 20

    Type parameters

    • T

    Parameters

    Returns number

    Returns the sum.

  • see

    _.sumBy

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.sumBy

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.sumBy

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.sumBy

    Parameters

    Returns number

tail

  • tail<T>(array: List<T>): T[]
  • tail<T>(array: List<T>): T[]
  • Gets all but the first element of array.

    alias

    _.tail

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    Returns T[]

    Returns the slice of array.

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

take

  • take<T>(array: List<T>, n?: number): T[]
  • Creates a slice of array with n elements taken from the beginning.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    • Optional n: number

      The number of elements to take.

    Returns T[]

    Returns the slice of array.

takeRight

  • takeRight<T>(array: List<T>, n?: number): T[]
  • Creates a slice of array with n elements taken from the end.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to query.

    • Optional n: number

      The number of elements to take.

    Returns T[]

    Returns the slice of array.

takeRightWhile

  • takeRightWhile<TValue>(array: List<TValue>, predicate?: ListIterator<TValue, boolean>, thisArg?: any): TValue[]
  • takeRightWhile<TValue>(array: List<TValue>, predicate?: string, thisArg?: any): TValue[]
  • takeRightWhile<TWhere, TValue>(array: List<TValue>, predicate?: TWhere): TValue[]
  • Creates a slice of array with elements taken from the end. Elements are taken until predicate returns falsey. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>

      The array to query.

    • Optional predicate: ListIterator<TValue, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns TValue[]

    Returns the slice of array.

  • see

    _.takeRightWhile

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: string
    • Optional thisArg: any

    Returns TValue[]

  • see

    _.takeRightWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: TWhere

    Returns TValue[]

takeWhile

  • takeWhile<TValue>(array: List<TValue>, predicate?: ListIterator<TValue, boolean>, thisArg?: any): TValue[]
  • takeWhile<TValue>(array: List<TValue>, predicate?: string, thisArg?: any): TValue[]
  • takeWhile<TWhere, TValue>(array: List<TValue>, predicate?: TWhere): TValue[]
  • Creates a slice of array with elements taken from the beginning. Elements are taken until predicate returns falsey. The predicate is bound to thisArg and invoked with three arguments: (value, index, array).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>

      The array to query.

    • Optional predicate: ListIterator<TValue, boolean>

      The function invoked per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns TValue[]

    Returns the slice of array.

  • see

    _.takeWhile

    Type parameters

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: string
    • Optional thisArg: any

    Returns TValue[]

  • see

    _.takeWhile

    Type parameters

    • TWhere

    • TValue

    Parameters

    • array: List<TValue>
    • Optional predicate: TWhere

    Returns TValue[]

tap

  • tap<T>(value: T, interceptor: function, thisArg?: any): T
  • This method invokes interceptor and returns value. The interceptor is bound to thisArg and invoked with one argument; (value). The purpose of this method is to "tap into" a method chain in order to perform operations on intermediate results within the chain.

    parem

    thisArg The this binding of interceptor.

    Type parameters

    • T

    Parameters

    • value: T

      The value to provide to interceptor.

    • interceptor: function

      The function to invoke.

        • (value: T): void
        • Parameters

          • value: T

          Returns void

    • Optional thisArg: any

    Returns T

    Returns value.

template

  • Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is provided it takes precedence over _.templateSettings values.

    Note: In the development build _.template utilizes sourceURLs for easier debugging.

    For more information on precompiling templates see lodash's custom builds documentation.

    For more information on Chrome extension sandboxes see Chrome's extensions documentation.

    Parameters

    • string: string

      The template string.

    • Optional options: TemplateOptions

      The options object.

    Returns TemplateExecutor

    Returns the compiled template function.

throttle

  • throttle<T>(func: T, wait?: number, options?: ThrottleSettings): T & Cancelable
  • Creates a throttled function that only invokes func at most once per every wait milliseconds. The throttled function comes with a cancel method to cancel delayed invocations. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function return the result of the last func call.

    Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to throttle.

    • Optional wait: number

      The number of milliseconds to throttle invocations to.

    • Optional options: ThrottleSettings

      The options object.

    Returns T & Cancelable

    Returns the new throttled function.

thru

  • thru<T, TResult>(value: T, interceptor: function, thisArg?: any): TResult
  • This method is like _.tap except that it returns the result of interceptor.

    Type parameters

    • T

    • TResult

    Parameters

    • value: T

      The value to provide to interceptor.

    • interceptor: function

      The function to invoke.

        • (value: T): TResult
        • Parameters

          • value: T

          Returns TResult

    • Optional thisArg: any

      The this binding of interceptor.

    Returns TResult

    Returns the result of interceptor.

times

  • times<TResult>(n: number, iteratee: function): TResult[]
  • times(n: number): number[]
  • Invokes the iteratee function n times, returning an array of the results of each invocation. The iteratee is invoked with one argument; (index).

    Type parameters

    • TResult

    Parameters

    • n: number

      The number of times to invoke iteratee.

    • iteratee: function

      The function invoked per iteration.

        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    Returns TResult[]

    Returns the array of results.

  • see

    _.times

    Parameters

    • n: number

    Returns number[]

toArray

  • toArray<T>(value: List<T> | Dictionary<T> | NumericDictionary<T>): T[]
  • toArray<TValue, TResult>(value: TValue): TResult[]
  • toArray<TResult>(value?: any): TResult[]
  • Converts value to an array.

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the converted array.

  • see

    _.toArray

    Type parameters

    • TValue

    • TResult

    Parameters

    • value: TValue

    Returns TResult[]

  • see

    _.toArray

    Type parameters

    • TResult

    Parameters

    • Optional value: any

    Returns TResult[]

toInteger

  • toInteger(value: any): number
  • Converts value to an integer.

    Note: This function is loosely based on ToInteger.

    static
    memberof

    _

    category

    Lang

    example

    _.toInteger(3); // => 3

    _.toInteger(Number.MIN_VALUE); // => 0

    _.toInteger(Infinity); // => 1.7976931348623157e+308

    _.toInteger('3'); // => 3

    Parameters

    • value: any

      The value to convert.

    Returns number

    Returns the converted integer.

toLength

  • toLength(value: any): number
  • Converts value to an integer suitable for use as the length of an array-like object.

    Note: This method is based on ToLength.

    static
    memberof

    _

    category

    Lang

    example

    _.toLength(3); // => 3

    _.toLength(Number.MIN_VALUE); // => 0

    _.toLength(Infinity); // => 4294967295

    _.toLength('3'); // => 3

    Parameters

    • value: any

      The value to convert.

    Returns number

    Returns the converted integer.

toLower

  • toLower(string?: string): string
  • Converts string, as a whole, to lower case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the lower cased string.

toNumber

  • toNumber(value: any): number
  • Converts value to a number.

    static
    memberof

    _

    category

    Lang

    example

    _.toNumber(3); // => 3

    _.toNumber(Number.MIN_VALUE); // => 5e-324

    _.toNumber(Infinity); // => Infinity

    _.toNumber('3'); // => 3

    Parameters

    • value: any

      The value to process.

    Returns number

    Returns the number.

toPairs

  • toPairs<T>(object?: T): any[]
  • toPairs<T, TResult>(object?: T): TResult[]
  • Creates an array of own enumerable key-value pairs for object.

    Type parameters

    • T: object

    Parameters

    • Optional object: T

      The object to query.

    Returns any[]

    Returns the new array of key-value pairs.

  • Type parameters

    • T: object

    • TResult

    Parameters

    • Optional object: T

    Returns TResult[]

toPairsIn

  • toPairsIn<T>(object?: T): any[]
  • toPairsIn<T, TResult>(object?: T): TResult[]
  • Creates an array of own and inherited enumerable key-value pairs for object.

    Type parameters

    • T: object

    Parameters

    • Optional object: T

      The object to query.

    Returns any[]

    Returns the new array of key-value pairs.

  • Type parameters

    • T: object

    • TResult

    Parameters

    • Optional object: T

    Returns TResult[]

toPath

  • toPath(value: any): string[]
  • Converts value to a property path array.

    static
    memberof

    _

    category

    Util

    example

    _.toPath('a.b.c'); // => ['a', 'b', 'c']

    _.toPath('a[0].b.c'); // => ['a', '0', 'b', 'c']

    var path = ['a', 'b', 'c'], newPath = _.toPath(path);

    console.log(newPath); // => ['a', 'b', 'c']

    console.log(path === newPath); // => false

    Parameters

    • value: any

      The value to convert.

    Returns string[]

    Returns the new property path array.

toPlainObject

  • toPlainObject<TResult>(value?: any): TResult
  • Converts value to a plain object flattening inherited enumerable properties of value to own properties of the plain object.

    Type parameters

    • TResult: object

    Parameters

    • Optional value: any

      The value to convert.

    Returns TResult

    Returns the converted plain object.

toSafeInteger

  • toSafeInteger(value: any): number
  • Converts value to a safe integer. A safe integer can be compared and represented correctly.

    static
    memberof

    _

    category

    Lang

    example

    _.toSafeInteger(3); // => 3

    _.toSafeInteger(Number.MIN_VALUE); // => 0

    _.toSafeInteger(Infinity); // => 9007199254740991

    _.toSafeInteger('3'); // => 3

    Parameters

    • value: any

      The value to convert.

    Returns number

    Returns the converted integer.

toString

  • toString(value: any): string
  • Converts value to a string if it's not one. An empty string is returned for null and undefined values. The sign of -0 is preserved.

    static
    memberof

    _

    category

    Lang

    example

    _.toString(null); // => ''

    _.toString(-0); // => '-0'

    _.toString([1, 2, 3]); // => '1,2,3'

    Parameters

    • value: any

      The value to process.

    Returns string

    Returns the string.

toUpper

  • toUpper(string?: string): string
  • Converts string, as a whole, to upper case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the upper cased string.

transform

  • An alternative to _.reduce; this method transforms object to a new accumulator object which is the result of running each of its own enumerable properties through iteratee, with each invocation potentially mutating the accumulator object. The iteratee is bound to thisArg and invoked with four arguments: (accumulator, value, key, object). Iteratee functions may exit iteration early by explicitly returning false.

    Type parameters

    • T

    • TResult

    Parameters

    • object: T[]

      The object to iterate over.

    • Optional iteratee: MemoVoidArrayIterator<T, TResult[]>

      The function invoked per iteration.

    • Optional accumulator: TResult[]

      The custom accumulator value.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns TResult[]

    Returns the accumulated value.

  • see

    _.transform

    Type parameters

    • T

    • TResult

    Parameters

    Returns Dictionary<TResult>

  • see

    _.transform

    Type parameters

    • T

    • TResult

    Parameters

    Returns Dictionary<TResult>

  • see

    _.transform

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

trim

  • trim(string?: string, chars?: string): string
  • Removes leading and trailing whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

trimEnd

  • trimEnd(string?: string, chars?: string): string
  • Removes trailing whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

trimStart

  • trimStart(string?: string, chars?: string): string
  • Removes leading whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

truncate

  • Truncates string if it’s longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "…".

    Parameters

    • Optional string: string

      The string to truncate.

    • Optional options: TruncateOptions

      The options object or maximum string length.

    Returns string

    Returns the truncated string.

unary

  • unary<T>(func: T): T
  • Creates a function that accepts up to one argument, ignoring any additional arguments.

    static
    memberof

    _

    category

    Function

    example

    .map(['6', '8', '10'], .unary(parseInt)); // => [6, 8, 10]

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to cap arguments for.

    Returns T

    Returns the new function.

unescape

  • unescape(string?: string): string
  • The inverse of _.escape; this method converts the HTML entities &, <, >, ", ', and ` in string to their corresponding characters.

    Note: No other HTML entities are unescaped. To unescape additional HTML entities use a third-party library like he.

    Parameters

    • Optional string: string

      The string to unescape.

    Returns string

    Returns the unescaped string.

union

  • union<T>(...arrays: List<T>[]): T[]
  • Creates an array of unique values, in order, from all of the provided arrays using SameValueZero for equality comparisons.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      The arrays to inspect.

    Returns T[]

    Returns the new array of combined values.

unionBy

  • unionBy<T>(arrays: T[] | List<T>, iteratee?: function): T[]
  • unionBy<T, W>(arrays: T[] | List<T>, iteratee?: W): T[]
  • unionBy<T>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, iteratee?: function): T[]
  • unionBy<T, W>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, iteratee?: W): T[]
  • unionBy<T>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, iteratee?: function): T[]
  • unionBy<T, W>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, iteratee?: W): T[]
  • unionBy<T>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, arrays4: T[] | List<T>, iteratee?: function): T[]
  • unionBy<T, W>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, arrays4: T[] | List<T>, iteratee?: W): T[]
  • unionBy<T>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, arrays4: T[] | List<T>, arrays5: T[] | List<T>, iteratee?: function): T[]
  • unionBy<T, W>(arrays1: T[] | List<T>, arrays2: T[] | List<T>, arrays3: T[] | List<T>, arrays4: T[] | List<T>, arrays5: T[] | List<T>, iteratee?: W): T[]
  • unionBy<T>(arrays: T[] | List<T>, ...iteratee: any[]): T[]
  • This method is like _.union except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    Type parameters

    • T

    Parameters

    • arrays: T[] | List<T>

      The arrays to inspect.

    • Optional iteratee: function

      The iteratee invoked per element.

        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns T[]

    Returns the new array of combined values.

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: function
        • (value: T): any
        • Parameters

          • value: T

          Returns any

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    • W: Object

    Parameters

    • arrays1: T[] | List<T>
    • arrays2: T[] | List<T>
    • arrays3: T[] | List<T>
    • arrays4: T[] | List<T>
    • arrays5: T[] | List<T>
    • Optional iteratee: W

    Returns T[]

  • see

    _.unionBy

    Type parameters

    • T

    Parameters

    • arrays: T[] | List<T>
    • Rest ...iteratee: any[]

    Returns T[]

unionWith

  • unionWith(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.union except that it accepts comparator which is invoked to compare elements of arrays. The comparator is invoked with two arguments: (arrVal, othVal).

    static
    memberof

    _

    category

    Array

    example

    var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

    .unionWith(objects, others, .isEqual); // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns the new array of combined values.

uniq

  • uniq<T>(array: List<T>): T[]
  • uniq<T, TSort>(array: List<T>): T[]
  • Creates a duplicate-free version of an array, using SameValueZero for equality comparisons, in which only the first occurrence of each element is kept.

    static
    memberof

    _

    category

    Array

    example

    _.uniq([2, 1, 2]); // => [2, 1]

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to inspect.

    Returns T[]

    Returns the new duplicate free array.

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

uniqBy

  • uniqBy<T>(array: List<T>, iteratee: ListIterator<T, any>): T[]
  • uniqBy<T, TSort>(array: List<T>, iteratee: ListIterator<T, TSort>): T[]
  • uniqBy<T>(array: List<T>, iteratee: string): T[]
  • uniqBy<T>(array: List<T>, iteratee: Object): T[]
  • uniqBy<TWhere, T>(array: List<T>, iteratee: TWhere): T[]
  • This method is like _.uniq except that it accepts iteratee which is invoked for each element in array to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Array

    example

    _.uniqBy([2.1, 1.2, 2.3], Math.floor); // => [2.1, 1.2]

    // using the _.property iteratee shorthand _.uniqBy([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 1 }, { 'x': 2 }]

    Type parameters

    • T

    Parameters

    Returns T[]

    Returns the new duplicate free array.

  • see

    _.uniqBy

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • iteratee: string

    Returns T[]

  • see

    _.uniqBy

    Type parameters

    • T

    Parameters

    • array: List<T>
    • iteratee: Object

    Returns T[]

  • see

    _.uniqBy

    Type parameters

    • TWhere: object

    • T

    Parameters

    • array: List<T>
    • iteratee: TWhere

    Returns T[]

uniqWith

  • uniqWith(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.uniq except that it accepts comparator which is invoked to compare elements of array. The comparator is invoked with two arguments: (arrVal, othVal).

    static
    memberof

    _

    category

    Array

    example

    var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }];

    .uniqWith(objects, .isEqual); // => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]

    Parameters

    • array: any[] | List<any>

      The array to inspect.

    • Rest ...values: any[]

    Returns any[]

    Returns the new duplicate free array.

uniqueId

  • uniqueId(prefix?: string): string
  • Generates a unique ID. If prefix is provided the ID is appended to it.

    Parameters

    • Optional prefix: string

      The value to prefix the ID with.

    Returns string

    Returns the unique ID.

unset

  • Removes the property at path of object.

    Note: This method mutates object.

    Type parameters

    • T

    Parameters

    Returns boolean

    Returns true if the property is deleted, else false.

unzip

  • This method is like _.zip except that it accepts an array of grouped elements and creates an array regrouping the elements to their pre-zip configuration.

    Type parameters

    • T

    Parameters

    • array: List<List<T>>

      The array of grouped elements to process.

    Returns T[]

    Returns the new array of regrouped elements.

unzipWith

  • unzipWith<TArray, TResult>(array: List<List<TArray>>, iteratee?: MemoIterator<TArray, TResult>, thisArg?: any): TResult[]
  • This method is like _.unzip except that it accepts an iteratee to specify how regrouped values should be combined. The iteratee is bound to thisArg and invoked with four arguments: (accumulator, value, index, group).

    Type parameters

    • TArray

    • TResult

    Parameters

    • array: List<List<TArray>>

      The array of grouped elements to process.

    • Optional iteratee: MemoIterator<TArray, TResult>

      The function to combine regrouped values.

    • Optional thisArg: any

      The this binding of iteratee.

    Returns TResult[]

    Returns the new array of regrouped elements.

upperCase

  • upperCase(string?: string): string
  • Converts string, as space separated words, to upper case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the upper cased string.

upperFirst

  • upperFirst(string?: string): string
  • Converts the first character of string to upper case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the converted string.

values

  • values<T>(object?: any): T[]
  • Creates an array of the own enumerable property values of object.

    Type parameters

    • T

    Parameters

    • Optional object: any

      The object to query.

    Returns T[]

    Returns an array of property values.

valuesIn

  • valuesIn<T>(object?: any): T[]
  • Creates an array of the own and inherited enumerable property values of object.

    Type parameters

    • T

    Parameters

    • Optional object: any

      The object to query.

    Returns T[]

    Returns the array of property values.

without

  • without<T>(array: List<T>, ...values: T[]): T[]
  • Creates an array excluding all provided values using SameValueZero for equality comparisons.

    Type parameters

    • T

    Parameters

    • array: List<T>

      The array to filter.

    • Rest ...values: T[]

      The values to exclude.

    Returns T[]

    Returns the new array of filtered values.

words

  • words(string?: string, pattern?: string | RegExp): string[]
  • Splits string into an array of its words.

    Parameters

    • Optional string: string

      The string to inspect.

    • Optional pattern: string | RegExp

      The pattern to match words.

    Returns string[]

    Returns the words of string.

wrap

  • wrap<V, W, R>(value: V, wrapper: W): R
  • wrap<V, R>(value: V, wrapper: Function): R
  • wrap<R>(value: any, wrapper: Function): R
  • Creates a function that provides value to the wrapper function as its first argument. Any additional arguments provided to the function are appended to those provided to the wrapper function. The wrapper is invoked with the this binding of the created function.

    Type parameters

    • V

    • W: Function

    • R: Function

    Parameters

    • value: V

      The value to wrap.

    • wrapper: W

      The wrapper function.

    Returns R

    Returns the new function.

  • see

    _.wrap

    Type parameters

    • V

    • R: Function

    Parameters

    • value: V
    • wrapper: Function

    Returns R

  • see

    _.wrap

    Type parameters

    • R: Function

    Parameters

    • value: any
    • wrapper: Function

    Returns R

xor

  • xor<T>(...arrays: List<T>[]): T[]
  • Creates an array of unique values that is the symmetric difference of the provided arrays.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      The arrays to inspect.

    Returns T[]

    Returns the new array of values.

xorBy

  • xorBy(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.xor except that it accepts iteratee which is invoked for each element of each arrays to generate the criterion by which uniqueness is computed. The iteratee is invoked with one argument: (value).

    static
    memberof

    _

    category

    Array

    example

    _.xorBy([2.1, 1.2], [4.3, 2.4], Math.floor); // => [1.2, 4.3]

    // using the _.property iteratee shorthand _.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x'); // => [{ 'x': 2 }]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns the new array of values.

xorWith

  • xorWith(array: any[] | List<any>, ...values: any[]): any[]
  • This method is like _.xor except that it accepts comparator which is invoked to compare elements of arrays. The comparator is invoked with two arguments: (arrVal, othVal).

    static
    memberof

    _

    category

    Array

    example

    var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

    .xorWith(objects, others, .isEqual); // => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

    Parameters

    • array: any[] | List<any>
    • Rest ...values: any[]

    Returns any[]

    Returns the new array of values.

zip

  • zip<T>(...arrays: List<T>[]): T[]
  • Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      The arrays to process.

    Returns T[]

    Returns the new array of grouped elements.

zipObject

  • The inverse of _.pairs; this method returns an object composed from arrays of property names and values. Provide either a single two dimensional array, e.g. [[key1, value1], [key2, value2]] or two arrays, one of property names and one of corresponding values.

    Type parameters

    • TValues

    • TResult: object

    Parameters

    Returns TResult

    Returns the new object.

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    Returns TResult

  • see

    _.zipObject

    Parameters

    Returns Dictionary<any>

zipWith

  • zipWith<TResult>(...args: any[]): TResult[]
  • This method is like _.zip except that it accepts an iteratee to specify how grouped values should be combined. The iteratee is bound to thisArg and invoked with four arguments: (accumulator, value, index, group).

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns TResult[]

    Returns the new array of grouped elements.

LoDashWrapperBase

LoDashWrapperBase:

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toString

  • toString(): string
  • Produces the result of coercing the unwrapped value to a string.

    Returns string

    Returns the coerced string value.

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    alias

    .toJSON, .valueOf

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T
  • see

    _.value

    Returns T

MapCache

MapCache:

Creates a cache object to store key/value pairs.

delete

  • delete(key: string): boolean
  • Removes key and its value from the cache.

    Parameters

    • key: string

      The key of the value to remove.

    Returns boolean

    Returns true if the entry was removed successfully, else false.

get

  • get(key: string): any
  • Gets the cached value for key.

    Parameters

    • key: string

      The key of the value to get.

    Returns any

    Returns the cached value.

has

  • has(key: string): boolean
  • Checks if a cached value for key exists.

    Parameters

    • key: string

      The key of the entry to check.

    Returns boolean

    Returns true if an entry for key exists, else false.

set

  • Sets value to key of the cache.

    Parameters

    • key: string

      The key of the value to cache.

    • value: any

      The value to cache.

    Returns Dictionary<any>

    Returns the cache object.

MemoIterator

  • __call(prev: TResult, curr: T, indexOrKey?: any, list?: T[]): TResult
  • Parameters

    • prev: TResult
    • curr: T
    • Optional indexOrKey: any
    • Optional list: T[]

    Returns TResult

MemoVoidArrayIterator

  • __call(acc: TResult, curr: T, index?: number, arr?: T[]): void
  • Parameters

    • acc: TResult
    • curr: T
    • Optional index: number
    • Optional arr: T[]

    Returns void

MemoVoidDictionaryIterator

  • __call(acc: TResult, curr: T, key?: string, dict?: Dictionary<T>): void
  • Parameters

    • acc: TResult
    • curr: T
    • Optional key: string
    • Optional dict: Dictionary<T>

    Returns void

MemoVoidIterator

  • __call(prev: TResult, curr: T, indexOrKey?: any, list?: T[]): void
  • Parameters

    • prev: TResult
    • curr: T
    • Optional indexOrKey: any
    • Optional list: T[]

    Returns void

MemoizedFunction

MemoizedFunction:

Function

Function: FunctionConstructor

arguments

arguments: any

cache

cache: MapCache

caller

caller: Function

length

length: number

name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

prototype

prototype: any

__@hasInstance

  • __@hasInstance(value: any): boolean
  • Determines whether the given value inherits from this function if this function was used as a constructor function.

    A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

    Parameters

    • value: any

    Returns boolean

apply

  • apply(thisArg: any, argArray?: any): any
  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(thisArg: any, ...argArray: any[]): any
  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(thisArg: any, ...argArray: any[]): any
  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

MergeWithCustomizer

  • __call(value: any, srcValue: any, key?: string, object?: Object, source?: Object): any
  • Parameters

    • value: any
    • srcValue: any
    • Optional key: string
    • Optional object: Object
    • Optional source: Object

    Returns any

MixinOptions

MixinOptions:

chain

chain: boolean

NumericDictionary

NumericDictionary:

NumericDictionaryIterator

  • __call(value: T, key?: number, collection?: Dictionary<T>): TResult
  • Parameters

    • value: T
    • Optional key: number
    • Optional collection: Dictionary<T>

    Returns TResult

ObjectIterator

  • __call(element: T, key?: string, collection?: any): TResult
  • Parameters

    • element: T
    • Optional key: string
    • Optional collection: any

    Returns TResult

Partial

  • __call<R>(func: Function0<R>): Function0<R>
  • __call<T1, R>(func: Function1<T1, R>): Function1<T1, R>
  • __call<T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1): Function1<T2, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, plc1: PH, arg2: T2): Function1<T1, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0<R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1): Function2<T2, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, arg2: T2): Function2<T1, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2): Function1<T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, plc2: PH, arg3: T3): Function2<T1, T2, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, arg3: T3): Function1<T2, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, plc1: PH, arg2: T2, arg3: T3): Function1<T1, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0<R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4<T1, T2, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1): Function3<T2, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2): Function3<T1, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2): Function2<T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, arg3: T3): Function3<T1, T2, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3): Function2<T2, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, arg3: T3): Function2<T1, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3): Function1<T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, plc3: PH, arg4: T4): Function3<T1, T2, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, arg4: T4): Function2<T2, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, plc3: PH, arg4: T4): Function2<T1, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, arg4: T4): Function1<T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, plc2: PH, arg3: T3, arg4: T4): Function2<T1, T2, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, arg4: T4): Function1<T2, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, plc1: PH, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0<R>
  • __call(func: Function, ...args: any[]): Function
  • Type parameters

    • R

    Parameters

    Returns Function0<R>

  • Type parameters

    • T1

    • R

    Parameters

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • R

    Parameters

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    • func: Function2<T1, T2, R>
    • arg1: T1
    • arg2: T2

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function3<T1, T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T1, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • arg2: T2

    Returns Function1<T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • plc1: PH
    • arg2: T2
    • arg3: T3

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function4<T1, T2, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1

    Returns Function3<T2, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T1, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2

    Returns Function2<T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T1, T2, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3

    Returns Function2<T2, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • plc1: PH
    • arg2: T2
    • arg3: T3

    Returns Function2<T1, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3

    Returns Function1<T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T1, T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • plc3: PH
    • arg4: T4

    Returns Function2<T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • plc1: PH
    • arg2: T2
    • plc3: PH
    • arg4: T4

    Returns Function2<T1, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • plc3: PH
    • arg4: T4

    Returns Function1<T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • plc1: PH
    • plc2: PH
    • arg3: T3
    • arg4: T4

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3
    • arg4: T4

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • plc1: PH
    • arg2: T2
    • arg3: T3
    • arg4: T4

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3
    • arg4: T4

    Returns Function0<R>

  • Parameters

    • func: Function
    • Rest ...args: any[]

    Returns Function

PartialRight

  • __call<R>(func: Function0<R>): Function0<R>
  • __call<T1, R>(func: Function1<T1, R>): Function1<T1, R>
  • __call<T1, R>(func: Function1<T1, R>, arg1: T1): Function0<R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>): Function2<T1, T2, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, plc2: PH): Function1<T2, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, arg2: T2): Function1<T1, R>
  • __call<T1, T2, R>(func: Function2<T1, T2, R>, arg1: T1, arg2: T2): Function0<R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>): Function3<T1, T2, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, plc3: PH): Function2<T2, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, plc3: PH): Function2<T1, T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, plc3: PH): Function1<T3, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg3: T3): Function2<T1, T2, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, plc2: PH, arg3: T3): Function1<T2, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg2: T2, arg3: T3): Function1<T1, R>
  • __call<T1, T2, T3, R>(func: Function3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): Function0<R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>): Function4<T1, T2, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, plc4: PH): Function3<T2, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: PH, plc4: PH): Function3<T1, T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, plc4: PH): Function2<T3, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, plc4: PH): Function3<T1, T2, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, plc4: PH): Function2<T2, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, plc4: PH): Function2<T1, T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, plc4: PH): Function1<T4, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg4: T4): Function3<T1, T2, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, plc3: PH, arg4: T4): Function2<T2, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, plc3: PH, arg4: T4): Function2<T1, T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, plc3: PH, arg4: T4): Function1<T3, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg3: T3, arg4: T4): Function2<T1, T2, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, plc2: PH, arg3: T3, arg4: T4): Function1<T2, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg2: T2, arg3: T3, arg4: T4): Function1<T1, R>
  • __call<T1, T2, T3, T4, R>(func: Function4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): Function0<R>
  • __call(func: Function, ...args: any[]): Function
  • Type parameters

    • R

    Parameters

    Returns Function0<R>

  • Type parameters

    • T1

    • R

    Parameters

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • R

    Parameters

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • R

    Parameters

    • func: Function2<T1, T2, R>
    • arg1: T1
    • arg2: T2

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function3<T1, T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T1, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • arg2: T2
    • plc3: PH

    Returns Function1<T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg2: T2
    • arg3: T3

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • T3

    • R

    Parameters

    • func: Function3<T1, T2, T3, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3

    Returns Function0<R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function4<T1, T2, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T2, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T1, T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • plc3: PH
    • plc4: PH

    Returns Function2<T3, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    Returns Function3<T1, T2, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3
    • plc4: PH

    Returns Function2<T2, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg2: T2
    • arg3: T3
    • plc4: PH

    Returns Function2<T1, T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3
    • plc4: PH

    Returns Function1<T4, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg4: T4

    Returns Function3<T1, T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • plc3: PH
    • arg4: T4

    Returns Function2<T2, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg2: T2
    • plc3: PH
    • arg4: T4

    Returns Function2<T1, T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • plc3: PH
    • arg4: T4

    Returns Function1<T3, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg3: T3
    • arg4: T4

    Returns Function2<T1, T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • plc2: PH
    • arg3: T3
    • arg4: T4

    Returns Function1<T2, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg2: T2
    • arg3: T3
    • arg4: T4

    Returns Function1<T1, R>

  • Type parameters

    • T1

    • T2

    • T3

    • T4

    • R

    Parameters

    • func: Function4<T1, T2, T3, T4, R>
    • arg1: T1
    • arg2: T2
    • arg3: T3
    • arg4: T4

    Returns Function0<R>

  • Parameters

    • func: Function
    • Rest ...args: any[]

    Returns Function

RecursiveArray

RecursiveArray:

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

__@iterator

  • Iterator

    Returns IterableIterator<T | RecursiveArray<T>>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

concat

  • Combines two or more arrays.

    Type parameters

    Parameters

    • Rest ...items: U[]

      Additional items to add to the end of array1.

    Returns T | RecursiveArray<T>

  • Combines two or more arrays.

    Parameters

    • Rest ...items: T | RecursiveArray<T>

      Additional items to add to the end of array1.

    Returns T | RecursiveArray<T>

copyWithin

  • copyWithin(target: number, start: number, end?: number): T | RecursiveArray<T>
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns T | RecursiveArray<T>

entries

  • Returns an array of key, value pairs for every entry in the array

    Returns IterableIterator<[number, T | RecursiveArray<T>]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: T | RecursiveArray<T>

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns T | RecursiveArray<T>

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns T | RecursiveArray<T>

find

  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns T | RecursiveArray<T>

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: T | RecursiveArray<T>, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T | RecursiveArray<T>

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an list of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: T | RecursiveArray<T>, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T | RecursiveArray<T>

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns T | RecursiveArray<T>

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • reduce(callbackfn: function, initialValue?: T | RecursiveArray<T>): T | RecursiveArray<T>
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: T | RecursiveArray<T>

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T | RecursiveArray<T>

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function, initialValue?: T | RecursiveArray<T>): T | RecursiveArray<T>
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: T | RecursiveArray<T>

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T | RecursiveArray<T>

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns T | RecursiveArray<T>

shift

  • Removes the first element from an array and returns it.

    Returns T | RecursiveArray<T>

slice

  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns T | RecursiveArray<T>

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns T | RecursiveArray<T>

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    Returns T | RecursiveArray<T>

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: T | RecursiveArray<T>

      Elements to insert into the array in place of the deleted elements.

    Returns T | RecursiveArray<T>

toLocaleString

  • toLocaleString(): string
  • Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: T | RecursiveArray<T>

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an list of values in the array

    Returns IterableIterator<T | RecursiveArray<T>>

SetWithCustomizer

  • __call(nsValue: any, key: string, nsObject: T): any
  • Parameters

    • nsValue: any
    • key: string
    • nsObject: T

    Returns any

StringIterator

  • __call(char: string, index?: number, string?: string): TResult
  • Parameters

    • char: string
    • Optional index: number
    • Optional string: string

    Returns TResult

StringRepresentable

StringRepresentable:

toString

  • toString(): string
  • Returns string

TemplateExecutor

  • __call(data?: Object): string
  • Parameters

    • Optional data: Object

    Returns string

source

source: string

TemplateOptions

TemplateOptions:

escape

escape: RegExp

The "escape" delimiter.

evaluate

evaluate: RegExp

The "evaluate" delimiter.

imports

imports: Dictionary<any>

An object to import into the template as local variables.

interpolate

interpolate: RegExp

The "interpolate" delimiter.

sourceURL

sourceURL: string

The sourceURL of the template's compiled source.

variable

variable: string

Used to reference the data object in the template text.

TemplateSettings

TemplateSettings:

By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.

escape

escape: RegExp

The "escape" delimiter.

evaluate

evaluate: RegExp

The "evaluate" delimiter.

imports

imports: Dictionary<any>

An object to import into the template as local variables.

interpolate

interpolate: RegExp

The "interpolate" delimiter.

variable

variable: string

Used to reference the data object in the template text.

ThrottleSettings

ThrottleSettings:

leading

leading: boolean

If you'd like to disable the leading-edge call, pass this as false.

trailing

trailing: boolean

If you'd like to disable the execution on the trailing-edge, pass false.

TruncateOptions

TruncateOptions:

length

length: number

The maximum string length.

omission

omission: string

The string to indicate text is omitted.

separator

separator: string | RegExp

The separator pattern to truncate to.

isMatchCustomizer

  • __call(value: any, other: any, indexOrKey?: number | string): boolean
  • Parameters

    • value: any
    • other: any
    • Optional indexOrKey: number | string

    Returns boolean

isMatchWithCustomizer

  • __call(value: any, other: any, indexOrKey?: number | string): boolean
  • Parameters

    • value: any
    • other: any
    • Optional indexOrKey: number | string

    Returns boolean

PH

"typings/main/ambient/mocha/index.d"

"typings/main/ambient/mocha/index.d":

"mocha"

"mocha":

Mocha

Mocha:

reporters

reporters:

Base

Base:

constructor

  • Parameters

    Returns Base

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Doc

Doc:

constructor

  • Parameters

    Returns Doc

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Dot

Dot:

constructor

  • Parameters

    Returns Dot

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTML

HTML:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTMLCov

HTMLCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSON

JSON:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONCov

JSONCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONStream

JSONStream:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Landing

Landing:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

List

List:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Markdown

Markdown:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Min

Min:

constructor

  • Parameters

    Returns Min

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Nyan

Nyan:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Progress

Progress:

constructor

  • Parameters

    • runner: IRunner
    • Optional options: object
      • Optional close?: string

        String used to indicate the end of the progress bar.

      • Optional complete?: string

        String used to indicate a complete test on the progress bar.

      • Optional incomplete?: string

        String used to indicate an incomplete test on the progress bar.

      • Optional open?: string

        String used to indicate the start of the progress bar.

    Returns Progress

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Spec

Spec:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

TAP

TAP:

constructor

  • Parameters

    Returns TAP

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

XUnit

XUnit:

constructor

  • Parameters

    • runner: IRunner
    • Optional options: any

    Returns XUnit

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

IContextDefinition

  • __call(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

only

  • only(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

skip

  • skip(description: string, spec: function): void
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

IRunnable

IRunnable:

Partial interface for Mocha's Runnable class.

async

async: boolean

fn

fn: Function

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

IRunner

IRunner:

Partial interface for Mocha's Runner class.

ISuite

ISuite:

Partial interface for Mocha's Suite class.

parent

parent: ISuite

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITest

ITest:

Partial interface for Mocha's Test class.

async

async: boolean

fn

fn: Function

parent

parent: ISuite

pending

pending: boolean

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITestDefinition

  • __call(expectation: string, assertion?: function): ITest
  • __call(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

only

  • only(expectation: string, assertion?: function): ITest
  • only(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

skip

  • skip(expectation: string, assertion?: function): void
  • skip(expectation: string, assertion?: function): void
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

constructor

  • new Mocha(options?: object): Mocha
  • Parameters

    • Optional options: object
      • Optional bail?: boolean
      • Optional grep?: RegExp
      • Optional reporter?: string
      • Optional timeout?: number
      • Optional ui?: string

    Returns Mocha

addFile

  • addFile(file: string): Mocha
  • Parameters

    • file: string

    Returns Mocha

asyncOnly

  • asyncOnly(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

bail

  • bail(value?: boolean): Mocha
  • Parameters

    • Optional value: boolean

    Returns Mocha

checkLeaks

  • Returns Mocha

enableTimeouts

  • enableTimeouts(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

globals

  • globals(value: string): Mocha
  • globals(values: string[]): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • values: string[]

    Returns Mocha

grep

  • grep(value: string): Mocha
  • grep(value: RegExp): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • value: RegExp

    Returns Mocha

growl

  • Enables growl support.

    Returns Mocha

ignoreLeaks

  • ignoreLeaks(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

invert

  • Returns Mocha

noHighlighting

  • noHighlighting(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

reporter

  • reporter(name: string): Mocha
  • reporter(reporter: function): Mocha
  • Sets reporter by name, defaults to "spec".

    Parameters

    • name: string

    Returns Mocha

  • Sets reporter constructor, defaults to mocha.reporters.Spec.

    Parameters

    • reporter: function
        • (runner: IRunner, options: any): any
        • Parameters

          Returns any

    Returns Mocha

run

  • run(onComplete?: function): IRunner
  • Runs tests and invokes onComplete() when finished.

    Parameters

    • Optional onComplete: function
        • (failures: number): void
        • Parameters

          • failures: number

          Returns void

    Returns IRunner

setup

  • Setup mocha with the given options.

    Parameters

    Returns Mocha

slow

  • slow(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

throwError

  • throwError(error: Error): void
  • Function to allow assertion libraries to throw errors directly into mocha. This is useful when running tests in a browser because window.onerror will only receive the 'message' attribute of the Error.

    Parameters

    • error: Error

    Returns void

timeout

  • timeout(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

ui

  • ui(value: string): Mocha
  • Parameters

    • value: string

    Returns Mocha

useColors

  • useColors(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

useInlineDiffs

  • useInlineDiffs(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

MochaDone

  • __call(error?: Error): void
  • Parameters

    • Optional error: Error

    Returns void

MochaSetupOptions

MochaSetupOptions:

bail

bail: boolean

globals

globals: any[]

grep

grep: any

ignoreLeaks

ignoreLeaks: boolean

reporter

reporter: any

slow

slow: number

timeout

timeout: number

ui

ui: string

context

describe

it

mocha

mocha: Mocha

suite

test

xdescribe

xit

after

  • after(action: function): void
  • after(action: function): void
  • after(description: string, action: function): void
  • after(description: string, action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • description: string
    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • description: string
    • action: function

    Returns void

afterEach

  • afterEach(action: function): void
  • afterEach(action: function): void
  • afterEach(description: string, action: function): void
  • afterEach(description: string, action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • description: string
    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • description: string
    • action: function

    Returns void

before

  • before(action: function): void
  • before(action: function): void
  • before(description: string, action: function): void
  • before(description: string, action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • description: string
    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • description: string
    • action: function

    Returns void

beforeEach

  • beforeEach(action: function): void
  • beforeEach(action: function): void
  • beforeEach(description: string, action: function): void
  • beforeEach(description: string, action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

  • Parameters

    • description: string
    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • description: string
    • action: function

    Returns void

setup

  • setup(action: function): void
  • setup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteSetup

  • suiteSetup(action: function): void
  • suiteSetup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteTeardown

  • suiteTeardown(action: function): void
  • suiteTeardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

teardown

  • teardown(action: function): void
  • teardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

"typings/main/ambient/node-uuid-base/index.d"

"typings/main/ambient/node-uuid-base/index.d":

___NodeUUID

___NodeUUID:

Common definitions for all environments

UUID

UUID:

parse

  • parse(id: string, buffer?: number[], offset?: number): number[]
  • Parameters

    • id: string
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

unparse

  • unparse(buffer: number[], offset?: number): string
  • Parameters

    • buffer: number[]
    • Optional offset: number

    Returns string

v1

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

v2

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

v3

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

v4

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

UUIDOptions

UUIDOptions:

clockseq

clockseq: number

(Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used.

msecs

msecs: number | Date

(Number | Date) Time in milliseconds since unix Epoch. Default: The current time is used.

node

node: any[]

Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1.

nsecs

nsecs: number

(Number between 0-9999) additional time, in 100-nanosecond units. Ignored if msecs is unspecified. Default: internal uuid counter is used, as per 4.2.1.2.

"typings/main/ambient/node-uuid-cjs/index.d"

"typings/main/ambient/node-uuid-cjs/index.d":

"node-uuid"

"node-uuid":

Expose as CommonJS module For use in node environment or browser environment (using webpack or other module loaders)

uuid

uuid: UUID

"typings/main/ambient/node-uuid/index.d"

"typings/main/ambient/node-uuid/index.d":

___NodeUUID

___NodeUUID:

Definitions for use in node environment

!! For browser enviroments, use node-uuid-global or node-uuid-cjs

UUID

UUID:

Overloads for node environment We need to duplicate some declarations because interface merging doesn't work with overloads

parse

  • parse(id: string, buffer?: number[], offset?: number): number[]
  • parse(id: string, buffer?: Buffer, offset?: number): Buffer
  • Parameters

    • id: string
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

  • Parameters

    • id: string
    • Optional buffer: Buffer
    • Optional offset: number

    Returns Buffer

unparse

  • unparse(buffer: number[], offset?: number): string
  • unparse(buffer: Buffer, offset?: number): string
  • Parameters

    • buffer: number[]
    • Optional offset: number

    Returns string

  • Parameters

    • buffer: Buffer
    • Optional offset: number

    Returns string

v1

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

  • Parameters

    Returns Buffer

v2

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

  • Parameters

    Returns Buffer

v3

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

  • Parameters

    Returns Buffer

v4

  • Parameters

    Returns string

  • Parameters

    • Optional options: UUIDOptions
    • Optional buffer: number[]
    • Optional offset: number

    Returns number[]

  • Parameters

    Returns Buffer

"typings/main/ambient/node/index.d"

"typings/main/ambient/node/index.d":

"assert"

"assert":

internal

  • internal(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

AssertionError

AssertionError:

constructor

  • Parameters

    • Optional options: object
      • Optional actual?: any
      • Optional expected?: any
      • Optional message?: string
      • Optional operator?: string
      • Optional stackStartFunction?: Function

    Returns AssertionError

actual

actual: any

expected

expected: any

generatedMessage

generatedMessage: boolean

message

message: string

name

name: string

operator

operator: string

doesNotThrow

doesNotThrow: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

throws

throws: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

deepEqual

  • deepEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

deepStrictEqual

  • deepStrictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

equal

  • equal(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ifError

  • ifError(value: any): void
  • Parameters

    • value: any

    Returns void

notDeepEqual

  • notDeepEqual(acutal: any, expected: any, message?: string): void
  • Parameters

    • acutal: any
    • expected: any
    • Optional message: string

    Returns void

notDeepStrictEqual

  • notDeepStrictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

notEqual

  • notEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

notStrictEqual

  • notStrictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

ok

  • ok(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

strictEqual

  • strictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

"buffer"

"buffer":
                                          *
              MODULES                     *
                                          *

BuffType

BuffType: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(array: Uint8Array): __type
    • new __type(array: any[]): __type
    • new __type(buffer: Buffer): __type
    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: string

        encoding to use, optional. Default is 'utf8'

      Returns __type

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: any[]

        The octets to store.

      Returns __type

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

      Parameters

      • string: string

        string to test.

      • Optional encoding: string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

  • compare: function
    • The same as buf1.compare(buf2).

      Parameters

      Returns number

  • concat: function
    • Returns a buffer which is the result of concatenating all the buffers in the list together.

      If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

      Parameters

      • list: Buffer[]

        An array of Buffer objects to concatenate

      • Optional totalLength: number

        Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Returns true if {obj} is a Buffer

      Parameters

      • obj: any

        object to test.

      Returns boolean

  • isEncoding: function
    • isEncoding(encoding: string): boolean
    • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

      Parameters

      • encoding: string

        string to test.

      Returns boolean

INSPECT_MAX_BYTES

INSPECT_MAX_BYTES: number

SlowBuffType

SlowBuffType: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(size: Uint8Array): __type
    • new __type(array: any[]): __type
    • Parameters

      • str: string
      • Optional encoding: string

      Returns __type

    • Parameters

      • size: number

      Returns __type

    • Parameters

      • size: Uint8Array

      Returns __type

    • Parameters

      • array: any[]

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function
    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Parameters

      • obj: any

      Returns boolean

"child_process"

"child_process":

ChildProcess

ChildProcess:

pid

pid: number

stderr

stderr: Readable

stdin

stdin: Writable

stdout

stdout: Readable

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

unref

  • unref(): void
  • Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

exec

  • exec(command: string, options: object, callback?: function): ChildProcess
  • exec(command: string, callback?: function): ChildProcess
  • Parameters

    • command: string
    • options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • command: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFile

  • execFile(file: string, callback?: function): ChildProcess
  • execFile(file: string, args?: string[], callback?: function): ChildProcess
  • execFile(file: string, args?: string[], options?: object, callback?: function): ChildProcess
  • Parameters

    • file: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFileSync

  • execFileSync(command: string, args?: string[], options?: object): string | Buffer
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns string | Buffer

execSync

  • execSync(command: string, options?: object): string | Buffer
  • Parameters

    • command: string
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns string | Buffer

fork

  • fork(modulePath: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • modulePath: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional env?: any
      • Optional execArgv?: string[]
      • Optional execPath?: string
      • Optional gid?: number
      • Optional silent?: boolean
      • Optional uid?: number

    Returns ChildProcess

spawn

  • spawn(command: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional custom?: any
      • Optional cwd?: string
      • Optional detached?: boolean
      • Optional env?: any
      • Optional stdio?: any

    Returns ChildProcess

spawnSync

  • spawnSync(command: string, args?: string[], options?: object): object
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns object

    • error: Error
    • output: string[]
    • pid: number
    • signal: string
    • status: number
    • stderr: string | Buffer
    • stdout: string | Buffer

"cluster"

"cluster":

Worker

Worker:

id

id: string

process

process: ChildProcess

suicide

suicide: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

destroy

  • destroy(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClusterSettings

ClusterSettings:

args

args: string[]

exec

exec: string

silent

silent: boolean

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: Worker[]

addListener

  • addListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

disconnect

  • disconnect(callback?: Function): void
  • Parameters

    • Optional callback: Function

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

fork

  • Parameters

    • Optional env: any

    Returns Worker

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • on(event: "disconnect", listener: function): void
  • on(event: "exit", listener: function): void
  • on(event: "fork", listener: function): void
  • on(event: "listening", listener: function): void
  • on(event: "message", listener: function): void
  • on(event: "online", listener: function): void
  • on(event: "setup", listener: function): void
  • on(event: string, listener: Function): any
  • Parameters

    • event: "disconnect"
    • listener: function
        • Parameters

          Returns void

    Returns void

  • Parameters

    • event: "exit"
    • listener: function
        • (worker: Worker, code: number, signal: string): void
        • Parameters

          • worker: Worker
          • code: number
          • signal: string

          Returns void

    Returns void

  • Parameters

    • event: "fork"
    • listener: function
        • Parameters

          Returns void

    Returns void

  • Parameters

    • event: "listening"
    • listener: function
        • (worker: Worker, address: any): void
        • Parameters

          Returns void

    Returns void

  • Parameters

    • event: "message"
    • listener: function
        • (worker: Worker, message: any): void
        • Parameters

          Returns void

    Returns void

  • Parameters

    • event: "online"
    • listener: function
        • Parameters

          Returns void

    Returns void

  • Parameters

    • event: "setup"
    • listener: function
        • (settings: any): void
        • Parameters

          • settings: any

          Returns void

    Returns void

  • Parameters

    • event: string
    • listener: Function

    Returns any

once

  • once(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): void
  • Parameters

    • Optional event: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

setupMaster

  • Parameters

    Returns void

"constants"

"constants":

DH_CHECK_P_NOT_PRIME

DH_CHECK_P_NOT_PRIME: number

DH_CHECK_P_NOT_SAFE_PRIME

DH_CHECK_P_NOT_SAFE_PRIME: number

DH_NOT_SUITABLE_GENERATOR

DH_NOT_SUITABLE_GENERATOR: number

DH_UNABLE_TO_CHECK_GENERATOR

DH_UNABLE_TO_CHECK_GENERATOR: number

E2BIG

E2BIG: number

EACCES

EACCES: number

EADDRINUSE

EADDRINUSE: number

EADDRNOTAVAIL

EADDRNOTAVAIL: number

EAFNOSUPPORT

EAFNOSUPPORT: number

EAGAIN

EAGAIN: number

EALREADY

EALREADY: number

EBADF

EBADF: number

EBADMSG

EBADMSG: number

EBUSY

EBUSY: number

ECANCELED

ECANCELED: number

ECHILD

ECHILD: number

ECONNABORTED

ECONNABORTED: number

ECONNREFUSED

ECONNREFUSED: number

ECONNRESET

ECONNRESET: number

EDEADLK

EDEADLK: number

EDESTADDRREQ

EDESTADDRREQ: number

EDOM

EDOM: number

EEXIST

EEXIST: number

EFAULT

EFAULT: number

EFBIG

EFBIG: number

EHOSTUNREACH

EHOSTUNREACH: number

EIDRM

EIDRM: number

EILSEQ

EILSEQ: number

EINPROGRESS

EINPROGRESS: number

EINTR

EINTR: number

EINVAL

EINVAL: number

EIO

EIO: number

EISCONN

EISCONN: number

EISDIR

EISDIR: number

ELOOP

ELOOP: number

EMFILE

EMFILE: number

EMLINK

EMLINK: number

EMSGSIZE

EMSGSIZE: number

ENAMETOOLONG

ENAMETOOLONG: number

ENETDOWN

ENETDOWN: number

ENETRESET

ENETRESET: number

ENETUNREACH

ENETUNREACH: number

ENFILE

ENFILE: number

ENGINE_METHOD_ALL

ENGINE_METHOD_ALL: number

ENGINE_METHOD_CIPHERS

ENGINE_METHOD_CIPHERS: number

ENGINE_METHOD_DH

ENGINE_METHOD_DH: number

ENGINE_METHOD_DIGESTS

ENGINE_METHOD_DIGESTS: number

ENGINE_METHOD_DSA

ENGINE_METHOD_DSA: number

ENGINE_METHOD_ECDH

ENGINE_METHOD_ECDH: number

ENGINE_METHOD_ECDSA

ENGINE_METHOD_ECDSA: number

ENGINE_METHOD_NONE

ENGINE_METHOD_NONE: number

ENGINE_METHOD_PKEY_ASN1_METHS

ENGINE_METHOD_PKEY_ASN1_METHS: number

ENGINE_METHOD_PKEY_METHS

ENGINE_METHOD_PKEY_METHS: number

ENGINE_METHOD_RAND

ENGINE_METHOD_RAND: number

ENGINE_METHOD_STORE

ENGINE_METHOD_STORE: number

ENOBUFS

ENOBUFS: number

ENODATA

ENODATA: number

ENODEV

ENODEV: number

ENOENT

ENOENT: number

ENOEXEC

ENOEXEC: number

ENOLCK

ENOLCK: number

ENOLINK

ENOLINK: number

ENOMEM

ENOMEM: number

ENOMSG

ENOMSG: number

ENOPROTOOPT

ENOPROTOOPT: number

ENOSPC

ENOSPC: number

ENOSR

ENOSR: number

ENOSTR

ENOSTR: number

ENOSYS

ENOSYS: number

ENOTCONN

ENOTCONN: number

ENOTDIR

ENOTDIR: number

ENOTEMPTY

ENOTEMPTY: number

ENOTSOCK

ENOTSOCK: number

ENOTSUP

ENOTSUP: number

ENOTTY

ENOTTY: number

ENXIO

ENXIO: number

EOPNOTSUPP

EOPNOTSUPP: number

EOVERFLOW

EOVERFLOW: number

EPERM

EPERM: number

EPIPE

EPIPE: number

EPROTO

EPROTO: number

EPROTONOSUPPORT

EPROTONOSUPPORT: number

EPROTOTYPE

EPROTOTYPE: number

ERANGE

ERANGE: number

EROFS

EROFS: number

ESPIPE

ESPIPE: number

ESRCH

ESRCH: number

ETIME

ETIME: number

ETIMEDOUT

ETIMEDOUT: number

ETXTBSY

ETXTBSY: number

EWOULDBLOCK

EWOULDBLOCK: number

EXDEV

EXDEV: number

F_OK

F_OK: number

NPN_ENABLED

NPN_ENABLED: number

O_APPEND

O_APPEND: number

O_CREAT

O_CREAT: number

O_EXCL

O_EXCL: number

O_RDONLY

O_RDONLY: number

O_RDWR

O_RDWR: number

O_TRUNC

O_TRUNC: number

O_WRONLY

O_WRONLY: number

POINT_CONVERSION_COMPRESSED

POINT_CONVERSION_COMPRESSED: number

POINT_CONVERSION_HYBRID

POINT_CONVERSION_HYBRID: number

POINT_CONVERSION_UNCOMPRESSED

POINT_CONVERSION_UNCOMPRESSED: number

RSA_NO_PADDING

RSA_NO_PADDING: number

RSA_PKCS1_OAEP_PADDING

RSA_PKCS1_OAEP_PADDING: number

RSA_PKCS1_PADDING

RSA_PKCS1_PADDING: number

RSA_PKCS1_PSS_PADDING

RSA_PKCS1_PSS_PADDING: number

RSA_SSLV23_PADDING

RSA_SSLV23_PADDING: number

RSA_X931_PADDING

RSA_X931_PADDING: number

R_OK

R_OK: number

SIGABRT

SIGABRT: number

SIGBREAK

SIGBREAK: number

SIGFPE

SIGFPE: number

SIGHUP

SIGHUP: number

SIGILL

SIGILL: number

SIGINT

SIGINT: number

SIGKILL

SIGKILL: number

SIGSEGV

SIGSEGV: number

SIGTERM

SIGTERM: number

SIGWINCH

SIGWINCH: number

SSL_OP_ALL

SSL_OP_ALL: number

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number

SSL_OP_CIPHER_SERVER_PREFERENCE

SSL_OP_CIPHER_SERVER_PREFERENCE: number

SSL_OP_CISCO_ANYCONNECT

SSL_OP_CISCO_ANYCONNECT: number

SSL_OP_COOKIE_EXCHANGE

SSL_OP_COOKIE_EXCHANGE: number

SSL_OP_CRYPTOPRO_TLSEXT_BUG

SSL_OP_CRYPTOPRO_TLSEXT_BUG: number

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number

SSL_OP_EPHEMERAL_RSA

SSL_OP_EPHEMERAL_RSA: number

SSL_OP_LEGACY_SERVER_CONNECT

SSL_OP_LEGACY_SERVER_CONNECT: number

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number

SSL_OP_MICROSOFT_SESS_ID_BUG

SSL_OP_MICROSOFT_SESS_ID_BUG: number

SSL_OP_MSIE_SSLV2_RSA_PADDING

SSL_OP_MSIE_SSLV2_RSA_PADDING: number

SSL_OP_NETSCAPE_CA_DN_BUG

SSL_OP_NETSCAPE_CA_DN_BUG: number

SSL_OP_NETSCAPE_CHALLENGE_BUG

SSL_OP_NETSCAPE_CHALLENGE_BUG: number

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number

SSL_OP_NO_COMPRESSION

SSL_OP_NO_COMPRESSION: number

SSL_OP_NO_QUERY_MTU

SSL_OP_NO_QUERY_MTU: number

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number

SSL_OP_NO_SSLv2

SSL_OP_NO_SSLv2: number

SSL_OP_NO_SSLv3

SSL_OP_NO_SSLv3: number

SSL_OP_NO_TICKET

SSL_OP_NO_TICKET: number

SSL_OP_NO_TLSv1

SSL_OP_NO_TLSv1: number

SSL_OP_NO_TLSv1_1

SSL_OP_NO_TLSv1_1: number

SSL_OP_NO_TLSv1_2

SSL_OP_NO_TLSv1_2: number

SSL_OP_PKCS1_CHECK_1

SSL_OP_PKCS1_CHECK_1: number

SSL_OP_PKCS1_CHECK_2

SSL_OP_PKCS1_CHECK_2: number

SSL_OP_SINGLE_DH_USE

SSL_OP_SINGLE_DH_USE: number

SSL_OP_SINGLE_ECDH_USE

SSL_OP_SINGLE_ECDH_USE: number

SSL_OP_SSLEAY_080_CLIENT_DH_BUG

SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number

SSL_OP_TLS_BLOCK_PADDING_BUG

SSL_OP_TLS_BLOCK_PADDING_BUG: number

SSL_OP_TLS_D5_BUG

SSL_OP_TLS_D5_BUG: number

SSL_OP_TLS_ROLLBACK_BUG

SSL_OP_TLS_ROLLBACK_BUG: number

S_IFCHR

S_IFCHR: number

S_IFDIR

S_IFDIR: number

S_IFLNK

S_IFLNK: number

S_IFMT

S_IFMT: number

S_IFREG

S_IFREG: number

UV_UDP_REUSEADDR

UV_UDP_REUSEADDR: number

WSAEACCES

WSAEACCES: number

WSAEADDRINUSE

WSAEADDRINUSE: number

WSAEADDRNOTAVAIL

WSAEADDRNOTAVAIL: number

WSAEAFNOSUPPORT

WSAEAFNOSUPPORT: number

WSAEALREADY

WSAEALREADY: number

WSAEBADF

WSAEBADF: number

WSAECANCELLED

WSAECANCELLED: number

WSAECONNABORTED

WSAECONNABORTED: number

WSAECONNREFUSED

WSAECONNREFUSED: number

WSAECONNRESET

WSAECONNRESET: number

WSAEDESTADDRREQ

WSAEDESTADDRREQ: number

WSAEDISCON

WSAEDISCON: number

WSAEDQUOT

WSAEDQUOT: number

WSAEFAULT

WSAEFAULT: number

WSAEHOSTDOWN

WSAEHOSTDOWN: number

WSAEHOSTUNREACH

WSAEHOSTUNREACH: number

WSAEINPROGRESS

WSAEINPROGRESS: number

WSAEINTR

WSAEINTR: number

WSAEINVAL

WSAEINVAL: number

WSAEINVALIDPROCTABLE

WSAEINVALIDPROCTABLE: number

WSAEINVALIDPROVIDER

WSAEINVALIDPROVIDER: number

WSAEISCONN

WSAEISCONN: number

WSAELOOP

WSAELOOP: number

WSAEMFILE

WSAEMFILE: number

WSAEMSGSIZE

WSAEMSGSIZE: number

WSAENAMETOOLONG

WSAENAMETOOLONG: number

WSAENETDOWN

WSAENETDOWN: number

WSAENETRESET

WSAENETRESET: number

WSAENETUNREACH

WSAENETUNREACH: number

WSAENOBUFS

WSAENOBUFS: number

WSAENOMORE

WSAENOMORE: number

WSAENOPROTOOPT

WSAENOPROTOOPT: number

WSAENOTCONN

WSAENOTCONN: number

WSAENOTEMPTY

WSAENOTEMPTY: number

WSAENOTSOCK

WSAENOTSOCK: number

WSAEOPNOTSUPP

WSAEOPNOTSUPP: number

WSAEPFNOSUPPORT

WSAEPFNOSUPPORT: number

WSAEPROCLIM

WSAEPROCLIM: number

WSAEPROTONOSUPPORT

WSAEPROTONOSUPPORT: number

WSAEPROTOTYPE

WSAEPROTOTYPE: number

WSAEPROVIDERFAILEDINIT

WSAEPROVIDERFAILEDINIT: number

WSAEREFUSED

WSAEREFUSED: number

WSAEREMOTE

WSAEREMOTE: number

WSAESHUTDOWN

WSAESHUTDOWN: number

WSAESOCKTNOSUPPORT

WSAESOCKTNOSUPPORT: number

WSAESTALE

WSAESTALE: number

WSAETIMEDOUT

WSAETIMEDOUT: number

WSAETOOMANYREFS

WSAETOOMANYREFS: number

WSAEUSERS

WSAEUSERS: number

WSAEWOULDBLOCK

WSAEWOULDBLOCK: number

WSANOTINITIALISED

WSANOTINITIALISED: number

WSASERVICE_NOT_FOUND

WSASERVICE_NOT_FOUND: number

WSASYSCALLFAILURE

WSASYSCALLFAILURE: number

WSASYSNOTREADY

WSASYSNOTREADY: number

WSATYPE_NOT_FOUND

WSATYPE_NOT_FOUND: number

WSAVERNOTSUPPORTED

WSAVERNOTSUPPORTED: number

WSA_E_CANCELLED

WSA_E_CANCELLED: number

WSA_E_NO_MORE

WSA_E_NO_MORE: number

W_OK

W_OK: number

X_OK

X_OK: number

"crypto"

"crypto":

Cipher

Cipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

CredentialDetails

CredentialDetails:

ca

ca: any

cert

cert: string

ciphers

ciphers: string

crl

crl: any

key

key: string

passphrase

passphrase: string

pfx

pfx: string

Credentials

Credentials:

context

context: any

Decipher

Decipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

DiffieHellman

DiffieHellman:

computeSecret

  • computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    • other_public_key: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

generateKeys

  • generateKeys(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getGenerator

  • getGenerator(encoding: string): string
  • Parameters

    • encoding: string

    Returns string

getPrime

  • getPrime(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPrivateKey

  • getPrivateKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPublicKey

  • getPublicKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

setPrivateKey

  • setPrivateKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

setPublicKey

  • setPublicKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

Hash

Hash:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hash
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hash

Hmac

Hmac:

readable

readable: boolean

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

update

  • update(data: any, input_encoding?: string): Hmac
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hmac

wrap

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Signer

Signer:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

sign

  • sign(private_key: string, output_format: string): string
  • Parameters

    • private_key: string
    • output_format: string

    Returns string

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Verify

Verify:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

verify

  • verify(object: string, signature: string, signature_format?: string): boolean
  • Parameters

    • object: string
    • signature: string
    • Optional signature_format: string

    Returns boolean

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

createCipher

  • createCipher(algorithm: string, password: any): Cipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Cipher

createCipheriv

  • createCipheriv(algorithm: string, key: any, iv: any): Cipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Cipher

createCredentials

createDecipher

  • createDecipher(algorithm: string, password: any): Decipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Decipher

createDecipheriv

  • createDecipheriv(algorithm: string, key: any, iv: any): Decipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Decipher

createDiffieHellman

  • Parameters

    • prime_length: number

    Returns DiffieHellman

  • Parameters

    • prime: number
    • Optional encoding: string

    Returns DiffieHellman

createHash

  • createHash(algorithm: string): Hash
  • Parameters

    • algorithm: string

    Returns Hash

createHmac

  • createHmac(algorithm: string, key: string): Hmac
  • createHmac(algorithm: string, key: Buffer): Hmac
  • Parameters

    • algorithm: string
    • key: string

    Returns Hmac

  • Parameters

    • algorithm: string
    • key: Buffer

    Returns Hmac

createSign

  • createSign(algorithm: string): Signer
  • Parameters

    • algorithm: string

    Returns Signer

createVerify

  • createVerify(algorith: string): Verify
  • Parameters

    • algorith: string

    Returns Verify

getDiffieHellman

  • Parameters

    • group_name: string

    Returns DiffieHellman

pbkdf2

  • pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, callback: function): void
  • pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string, callback: function): void
  • Parameters

    • password: string | Buffer
    • salt: string | Buffer
    • iterations: number
    • keylen: number
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

  • Parameters

    • password: string | Buffer
    • salt: string | Buffer
    • iterations: number
    • keylen: number
    • digest: string
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

pbkdf2Sync

  • pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number): Buffer
  • pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string): Buffer
  • Parameters

    • password: string | Buffer
    • salt: string | Buffer
    • iterations: number
    • keylen: number

    Returns Buffer

  • Parameters

    • password: string | Buffer
    • salt: string | Buffer
    • iterations: number
    • keylen: number
    • digest: string

    Returns Buffer

pseudoRandomBytes

  • pseudoRandomBytes(size: number): Buffer
  • pseudoRandomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

randomBytes

  • randomBytes(size: number): Buffer
  • randomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

"dgram"

"dgram":

AddressInfo

AddressInfo:

address

address: string

family

family: string

port

port: number

RemoteInfo

RemoteInfo:

address

address: string

port

port: number

size

size: number

Socket

Socket:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

address

  • Returns AddressInfo

bind

  • bind(port: number, address?: string, callback?: function): void
  • Parameters

    • port: number
    • Optional address: string
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

close

  • close(): void
  • Returns void

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: function): void
  • Parameters

    • buf: Buffer
    • offset: number
    • length: number
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void
        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

setBroadcast

  • setBroadcast(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMaxListeners

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMulticastTTL

  • setMulticastTTL(ttl: number): void
  • Parameters

    • ttl: number

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

createSocket

  • createSocket(type: string, callback?: function): Socket
  • Parameters

    Returns Socket

"dns"

"dns":

lookup

  • lookup(domain: string, family: number, callback: function): string
  • lookup(domain: string, callback: function): string
  • Parameters

    • domain: string
    • family: number
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

resolve

  • resolve(domain: string, rrtype: string, callback: function): string[]
  • resolve(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • rrtype: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve4

  • resolve4(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve6

  • resolve6(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveCname

  • resolveCname(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveMx

  • resolveMx(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveNs

  • resolveNs(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveSrv

  • resolveSrv(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveTxt

  • resolveTxt(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

reverse

  • reverse(ip: string, callback: function): string[]
  • Parameters

    • ip: string
    • callback: function
        • (err: Error, domains: string[]): void
        • Parameters

          • err: Error
          • domains: string[]

          Returns void

    Returns string[]

"domain"

"domain":

Domain

Domain:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

add

  • Parameters

    Returns void

addListener

  • addListener(event: string, listener: Function): Domain

bind

  • bind(cb: function): any
  • Parameters

    • cb: function
        • (err: Error, data: any): any
        • Parameters

          • err: Error
          • data: any

          Returns any

    Returns any

dispose

  • dispose(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

intercept

  • intercept(cb: function): any
  • Parameters

    • cb: function
        • (data: any): any
        • Parameters

          • data: any

          Returns any

    Returns any

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

  • on(event: string, listener: Function): Domain
  • Parameters

    • event: string
    • listener: Function

    Returns Domain

once

  • once(event: string, listener: Function): Domain

remove

  • Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): Domain

removeListener

  • removeListener(event: string, listener: Function): Domain

run

  • run(fn: Function): void
  • Parameters

    • fn: Function

    Returns void

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

create

  • Returns Domain

"events"

"events":

EventEmitter

EventEmitter:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number
  • Parameters

    Returns number

"fs"

"fs":

FSWatcher

FSWatcher:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadStream

ReadStream:

constructor

readable

readable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Stats

Stats:

atime

atime: Date

birthtime

birthtime: Date

blksize

blksize: number

blocks

blocks: number

ctime

ctime: Date

dev

dev: number

gid

gid: number

ino

ino: number

mode

mode: number

mtime

mtime: Date

nlink

nlink: number

rdev

rdev: number

size

size: number

uid

uid: number

isBlockDevice

  • isBlockDevice(): boolean
  • Returns boolean

isCharacterDevice

  • isCharacterDevice(): boolean
  • Returns boolean

isDirectory

  • isDirectory(): boolean
  • Returns boolean

isFIFO

  • isFIFO(): boolean
  • Returns boolean

isFile

  • isFile(): boolean
  • Returns boolean

isSocket

  • isSocket(): boolean
  • Returns boolean

isSymbolicLink

  • isSymbolicLink(): boolean
  • Returns boolean

WriteStream

WriteStream:

constructor

bytesWritten

bytesWritten: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

F_OK

F_OK: number

Constant for fs.access(). File is visible to the calling process.

R_OK

R_OK: number

Constant for fs.access(). File can be read by the calling process.

W_OK

W_OK: number

Constant for fs.access(). File can be written by the calling process.

X_OK

X_OK: number

Constant for fs.access(). File can be executed by the calling process.

access

  • access(path: string, callback: function): void
  • access(path: string, mode: number, callback: function): void
  • Tests a user's permissions for the file specified by path.

    Parameters

    Returns void

  • Parameters

    Returns void

accessSync

  • accessSync(path: string, mode?: number): void
  • Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise.

    Parameters

    • path: string
    • Optional mode: number

    Returns void

appendFile

  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, callback?: function): void
  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

appendFileSync

  • appendFileSync(filename: string, data: any, options?: object): void
  • appendFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

chmod

  • chmod(path: string, mode: number, callback?: function): void
  • chmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

chmodSync

  • chmodSync(path: string, mode: number): void
  • chmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

chown

  • chown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

chownSync

  • chownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

close

  • close(fd: number, callback?: function): void
  • Parameters

    Returns void

closeSync

  • closeSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

createReadStream

  • createReadStream(path: string, options?: object): ReadStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional autoClose?: boolean
      • Optional encoding?: string
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number

    Returns ReadStream

createWriteStream

  • createWriteStream(path: string, options?: object): WriteStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional encoding?: string
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number

    Returns WriteStream

exists

  • exists(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function
        • (exists: boolean): void
        • Parameters

          • exists: boolean

          Returns void

    Returns void

existsSync

  • existsSync(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

fchmod

  • fchmod(fd: number, mode: number, callback?: function): void
  • fchmod(fd: number, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

fchmodSync

  • fchmodSync(fd: number, mode: number): void
  • fchmodSync(fd: number, mode: string): void
  • Parameters

    • fd: number
    • mode: number

    Returns void

  • Parameters

    • fd: number
    • mode: string

    Returns void

fchown

  • fchown(fd: number, uid: number, gid: number, callback?: function): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns void

fstat

  • fstat(fd: number, callback?: function): void
  • Parameters

    Returns void

fstatSync

  • fstatSync(fd: number): Stats
  • Parameters

    • fd: number

    Returns Stats

fsync

  • fsync(fd: number, callback?: function): void
  • Parameters

    Returns void

fsyncSync

  • fsyncSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

ftruncate

  • ftruncate(fd: number, callback?: function): void
  • ftruncate(fd: number, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

ftruncateSync

  • ftruncateSync(fd: number, len?: number): void
  • Parameters

    • fd: number
    • Optional len: number

    Returns void

futimes

  • futimes(fd: number, atime: number, mtime: number, callback?: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

futimesSync

  • futimesSync(fd: number, atime: number, mtime: number): void
  • futimesSync(fd: number, atime: Date, mtime: Date): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date

    Returns void

lchmod

  • lchmod(path: string, mode: number, callback?: function): void
  • lchmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

lchmodSync

  • lchmodSync(path: string, mode: number): void
  • lchmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

lchown

  • lchown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

lchownSync

  • lchownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

link

  • link(srcpath: string, dstpath: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional callback: function

    Returns void

linkSync

  • linkSync(srcpath: string, dstpath: string): void
  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

lstat

  • lstat(path: string, callback?: function): void
  • Parameters

    Returns void

lstatSync

  • lstatSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

mkdir

  • mkdir(path: string, callback?: function): void
  • mkdir(path: string, mode: number, callback?: function): void
  • mkdir(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

mkdirSync

  • mkdirSync(path: string, mode?: number): void
  • mkdirSync(path: string, mode?: string): void
  • Parameters

    • path: string
    • Optional mode: number

    Returns void

  • Parameters

    • path: string
    • Optional mode: string

    Returns void

open

  • open(path: string, flags: string, callback?: function): void
  • open(path: string, flags: string, mode: number, callback?: function): void
  • open(path: string, flags: string, mode: string, callback?: function): void
  • Parameters

    • path: string
    • flags: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: string
    • Optional callback: function

    Returns void

openSync

  • openSync(path: string, flags: string, mode?: number): number
  • openSync(path: string, flags: string, mode?: string): number
  • Parameters

    • path: string
    • flags: string
    • Optional mode: number

    Returns number

  • Parameters

    • path: string
    • flags: string
    • Optional mode: string

    Returns number

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

readFile

  • readFile(filename: string, encoding: string, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, callback: function): void
  • Parameters

    • filename: string
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

readFileSync

  • readFileSync(filename: string, encoding: string): string
  • readFileSync(filename: string, options: object): string
  • readFileSync(filename: string, options?: object): Buffer
  • Parameters

    • filename: string
    • encoding: string

    Returns string

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string

    Returns string

  • Parameters

    • filename: string
    • Optional options: object
      • Optional flag?: string

    Returns Buffer

readSync

  • readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

readdir

  • readdir(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readdirSync

  • readdirSync(path: string): string[]
  • Parameters

    • path: string

    Returns string[]

readlink

  • readlink(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readlinkSync

  • readlinkSync(path: string): string
  • Parameters

    • path: string

    Returns string

realpath

  • realpath(path: string, callback?: function): void
  • realpath(path: string, cache: object, callback: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • cache: object
      • [path: string]: string
    • callback: function

    Returns void

realpathSync

  • realpathSync(path: string, cache?: object): string
  • Parameters

    • path: string
    • Optional cache: object
      • [path: string]: string

    Returns string

rename

  • rename(oldPath: string, newPath: string, callback?: function): void
  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string
    • Optional callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

renameSync

  • renameSync(oldPath: string, newPath: string): void
  • Synchronous rename

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string, callback?: function): void
  • Parameters

    Returns void

rmdirSync

  • rmdirSync(path: string): void
  • Parameters

    • path: string

    Returns void

stat

  • stat(path: string, callback?: function): void
  • Parameters

    Returns void

statSync

  • statSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

symlink

  • symlink(srcpath: string, dstpath: string, type?: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string
    • Optional callback: function

    Returns void

symlinkSync

  • symlinkSync(srcpath: string, dstpath: string, type?: string): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string

    Returns void

truncate

  • truncate(path: string, callback?: function): void
  • truncate(path: string, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

truncateSync

  • truncateSync(path: string, len?: number): void
  • Parameters

    • path: string
    • Optional len: number

    Returns void

unlink

  • unlink(path: string, callback?: function): void
  • Parameters

    Returns void

unlinkSync

  • unlinkSync(path: string): void
  • Parameters

    • path: string

    Returns void

unwatchFile

  • unwatchFile(filename: string, listener?: function): void
  • Parameters

    • filename: string
    • Optional listener: function

    Returns void

utimes

  • utimes(path: string, atime: number, mtime: number, callback?: function): void
  • utimes(path: string, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

utimesSync

  • utimesSync(path: string, atime: number, mtime: number): void
  • utimesSync(path: string, atime: Date, mtime: Date): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date

    Returns void

watch

  • watch(filename: string, listener?: function): FSWatcher
  • watch(filename: string, options: object, listener?: function): FSWatcher
  • Parameters

    • filename: string
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • options: object
      • Optional persistent?: boolean
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: string, listener: function): void
  • watchFile(filename: string, options: object, listener: function): void
  • Parameters

    • filename: string
    • listener: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • Optional interval?: number
      • Optional persistent?: boolean
    • listener: function

    Returns void

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, callback?: function): void
  • write(fd: number, data: any, callback?: function): void
  • write(fd: number, data: any, offset: number, callback?: function): void
  • write(fd: number, data: any, offset: number, encoding: string, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • data: any
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • encoding: string
    • Optional callback: function

    Returns void

writeFile

  • writeFile(filename: string, data: any, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

writeFileSync

  • writeFileSync(filename: string, data: any, options?: object): void
  • writeFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

writeSync

  • writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

"http"

"http":

Agent

Agent:

constructor

  • Parameters

    Returns Agent

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

destroy

  • destroy(): void
  • Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

    Returns void

AgentOptions

AgentOptions:

keepAlive

keepAlive: boolean

Keep sockets around in a pool to be used by other requests in the future. Default = false

keepAliveMsecs

keepAliveMsecs: number

When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

maxFreeSockets

maxFreeSockets: number

Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

maxSockets

maxSockets: number

Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

ClientRequest

ClientRequest:

constructor

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setSocketKeepAlive

  • setSocketKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClientResponse

ClientResponse:
deprecated

Use IncomingMessage

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

IncomingMessage

IncomingMessage:

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

RequestOptions

RequestOptions:

agent

agent: Agent | boolean

auth

auth: string

family

family: number

headers

headers: object

Type declaration

  • [key: string]: any

host

host: string

hostname

hostname: string

localAddress

localAddress: string

method

method: string

path

path: string

port

port: number

protocol

protocol: string

socketPath

socketPath: string

Server

Server:

maxHeadersCount

maxHeadersCount: number

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Parameters

    • Optional cb: any

    Returns Server

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listen

  • listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server
  • listen(port: number, hostname?: string, callback?: Function): Server
  • listen(path: string, callback?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional callback: Function

    Returns Server

  • Parameters

    • port: number
    • Optional hostname: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • path: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerRequest

ServerRequest:
deprecated

Use IncomingMessage

constructor

connection

connection: Socket

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerResponse

ServerResponse:

constructor

headersSent

headersSent: boolean

sendDate

sendDate: boolean

statusCode

statusCode: number

statusMessage

statusMessage: string

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

addTrailers

  • addTrailers(headers: any): void
  • Parameters

    • headers: any

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getHeader

  • getHeader(name: string): string
  • Parameters

    • name: string

    Returns string

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeHeader

  • removeHeader(name: string): void
  • Parameters

    • name: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setHeader

  • setHeader(name: string, value: string): void
  • Parameters

    • name: string
    • value: string

    Returns void

setMaxListeners

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): any
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns any

writeContinue

  • writeContinue(): void
  • Returns void

writeHead

  • writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void
  • writeHead(statusCode: number, headers?: any): void
  • Parameters

    • statusCode: number
    • Optional reasonPhrase: string
    • Optional headers: any

    Returns void

  • Parameters

    • statusCode: number
    • Optional headers: any

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

METHODS

METHODS: string[]

STATUS_CODES

STATUS_CODES: object

Type declaration

  • [errorCode: string]: string

globalAgent

globalAgent: Agent

createClient

  • createClient(port?: number, host?: string): any
  • Parameters

    • Optional port: number
    • Optional host: string

    Returns any

createServer

  • createServer(requestListener?: function): Server

get

request

"https"

"https":

Agent

Agent:

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

RequestOptions

RequestOptions:

agent

agent: Agent | boolean

auth

auth: string

ca

ca: any

cert

cert: any

ciphers

ciphers: string

family

family: number

headers

headers: object

Type declaration

  • [key: string]: any

host

host: string

hostname

hostname: string

key

key: any

localAddress

localAddress: string

method

method: string

passphrase

passphrase: string

path

path: string

pfx

pfx: any

port

port: number

protocol

protocol: string

rejectUnauthorized

rejectUnauthorized: boolean

secureProtocol

secureProtocol: string

socketPath

socketPath: string

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerOptions

ServerOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

globalAgent

globalAgent: Agent

createServer

  • Parameters

    Returns Server

get

request

"net"

"net":

Server

Server:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • close(callback?: Function): Server
  • Parameters

    • Optional callback: Function

    Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Socket

Socket:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding?: string): void
  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

connect

  • connect(options: object, connectionListener?: Function): Socket
  • connect(port: number, host?: string, connectionListener?: Function): Socket
  • connect(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
      • Optional family?: number
      • Optional host?: string
      • Optional localAddress?: string
      • Optional localPort?: string
      • port: number
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createConnection

  • createConnection(options: object, connectionListener?: Function): Socket
  • createConnection(port: number, host?: string, connectionListener?: Function): Socket
  • createConnection(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
      • Optional family?: number
      • Optional host?: string
      • Optional localAddress?: string
      • Optional localPort?: string
      • port: number
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createServer

  • createServer(connectionListener?: function): Server
  • createServer(options?: object, connectionListener?: function): Server
  • Parameters

    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

  • Parameters

    • Optional options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

isIP

  • isIP(input: string): number
  • Parameters

    • input: string

    Returns number

isIPv4

  • isIPv4(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

isIPv6

  • isIPv6(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

"os"

"os":

CpuInfo

CpuInfo:

model

model: string

speed

speed: number

times

times: object

Type declaration

  • idle: number
  • irq: number
  • nice: number
  • sys: number
  • user: number

NetworkInterfaceInfo

NetworkInterfaceInfo:

address

address: string

family

family: string

internal

internal: boolean

mac

mac: string

netmask

netmask: string

EOL

EOL: string

arch

  • arch(): string
  • Returns string

cpus

  • Returns CpuInfo[]

endianness

  • endianness(): string
  • Returns string

freemem

  • freemem(): number
  • Returns number

homedir

  • homedir(): string
  • Returns string

hostname

  • hostname(): string
  • Returns string

loadavg

  • loadavg(): number[]
  • Returns number[]

networkInterfaces

  • networkInterfaces(): object
  • Returns object

platform

  • platform(): string
  • Returns string

release

  • release(): string
  • Returns string

tmpdir

  • tmpdir(): string
  • Returns string

totalmem

  • totalmem(): number
  • Returns number

type

  • type(): string
  • Returns string

uptime

  • uptime(): number
  • Returns number

"path"

"path":

posix

posix:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

win32

win32:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

ParsedPath

ParsedPath:

A parsed path object generated by path.parse() or consumed by path.format().

base

base: string

The file name including extension (if any) such as 'index.html'

dir

dir: string

The full directory path such as '/home/user/dir' or 'c:\path\dir'

ext

ext: string

The file extension (if any) such as '.html'

name

name: string

The file name without extension (if any) such as 'index'

root

root: string

The root of the path such as '/' or 'c:\'

delimiter

delimiter: string

The platform-specific file delimiter. ';' or ':'.

sep

sep: string

The platform-specific file separator. '\' or '/'.

basename

  • basename(p: string, ext?: string): string
  • Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

    Parameters

    • p: string

      the path to evaluate.

    • Optional ext: string

      optionally, an extension to remove from the result.

    Returns string

dirname

  • dirname(p: string): string
  • Return the directory name of a path. Similar to the Unix dirname command.

    Parameters

    • p: string

      the path to evaluate.

    Returns string

extname

  • extname(p: string): string
  • Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string

    Parameters

    • p: string

      the path to evaluate.

    Returns string

format

  • Returns a path string from an object - the opposite of parse().

    Parameters

    Returns string

isAbsolute

  • isAbsolute(path: string): boolean
  • Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

    Parameters

    • path: string

      path to test.

    Returns boolean

join

  • join(...paths: any[]): string
  • join(...paths: string[]): string
  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: any[]

      string paths to join.

    Returns string

  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: string[]

      string paths to join.

    Returns string

normalize

  • normalize(p: string): string
  • Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

    Parameters

    • p: string

      string path to normalize.

    Returns string

parse

  • Returns an object from a path string - the opposite of format().

    Parameters

    • pathString: string

      path to evaluate.

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Solve the relative path from {from} to {to}. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.

    Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

    Starting from leftmost {from} paramter, resolves {to} to an absolute path.

    If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

    Parameters

    • Rest ...pathSegments: any[]

      string paths to join. Non-string arguments are ignored.

    Returns string

"punycode"

"punycode":

ucs2

ucs2:

decode

  • decode(string: string): number[]
  • Parameters

    • string: string

    Returns number[]

encode

  • encode(codePoints: number[]): string
  • Parameters

    • codePoints: number[]

    Returns string

version

version: any

decode

  • decode(string: string): string
  • Parameters

    • string: string

    Returns string

encode

  • encode(string: string): string
  • Parameters

    • string: string

    Returns string

toASCII

  • toASCII(domain: string): string
  • Parameters

    • domain: string

    Returns string

toUnicode

  • toUnicode(domain: string): string
  • Parameters

    • domain: string

    Returns string

"querystring"

"querystring":

ParseOptions

ParseOptions:

decodeURIComponent

decodeURIComponent: Function

maxKeys

maxKeys: number

StringifyOptions

StringifyOptions:

encodeURIComponent

encodeURIComponent: Function

escape

  • escape(str: string): string
  • Parameters

    • str: string

    Returns string

parse

  • parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any
  • parse<T>(str: string, sep?: string, eq?: string, options?: ParseOptions): T
  • Parameters

    • str: string
    • Optional sep: string
    • Optional eq: string
    • Optional options: ParseOptions

    Returns any

  • Type parameters

    • T: object

    Parameters

    • str: string
    • Optional sep: string
    • Optional eq: string
    • Optional options: ParseOptions

    Returns T

stringify

  • stringify<T>(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string
  • Type parameters

    • T

    Parameters

    • obj: T
    • Optional sep: string
    • Optional eq: string
    • Optional options: StringifyOptions

    Returns string

unescape

  • unescape(str: string): string
  • Parameters

    • str: string

    Returns string

"readline"

"readline":

Completer

  • __call(line: string): CompleterResult
  • __call(line: string, callback: function): any
  • Parameters

    • line: string

    Returns CompleterResult

  • Parameters

    Returns any

CompleterResult

CompleterResult:

completions

completions: string[]

line

line: string

Key

Key:

ctrl

ctrl: boolean

meta

meta: boolean

name

name: string

sequence

sequence: string

shift

shift: boolean

ReadLine

ReadLine:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • Returns ReadLine

prompt

  • prompt(preserveCursor?: boolean): void
  • Parameters

    • Optional preserveCursor: boolean

    Returns void

question

  • question(query: string, callback: function): void
  • Parameters

    • query: string
    • callback: function
        • (answer: string): void
        • Parameters

          • answer: string

          Returns void

    Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • Returns ReadLine

setMaxListeners

setPrompt

  • setPrompt(prompt: string): void
  • Parameters

    • prompt: string

    Returns void

write

  • write(data: string | Buffer, key?: Key): void
  • Parameters

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadLineOptions

ReadLineOptions:

completer

completer: Completer

historySize

historySize: number

input

output

terminal

terminal: boolean

clearLine

  • Parameters

    Returns void

clearScreenDown

  • Parameters

    Returns void

createInterface

cursorTo

  • Parameters

    Returns void

moveCursor

  • moveCursor(stream: WritableStream, dx: number | string, dy: number | string): void
  • Parameters

    Returns void

"repl"

"repl":

ReplOptions

ReplOptions:

eval

eval: Function

ignoreUndefined

ignoreUndefined: boolean

input

output

prompt

prompt: string

terminal

terminal: boolean

useColors

useColors: boolean

useGlobal

useGlobal: boolean

writer

writer: Function

start

"stream"

"stream":

Duplex

Duplex:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

PassThrough

PassThrough:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Readable

Readable:

constructor

readable

readable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Stream

Stream:

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Transform

Transform:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Writable

Writable:

constructor

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DuplexOptions

DuplexOptions:

allowHalfOpen

allowHalfOpen: boolean

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

ReadableOptions

ReadableOptions:

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

TransformOptions

TransformOptions:

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

WritableOptions

WritableOptions:

decodeStrings

decodeStrings: boolean

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

"string_decoder"

"string_decoder":

NodeStringDecoder

NodeStringDecoder:

detectIncompleteChar

  • detectIncompleteChar(buffer: Buffer): number
  • Parameters

    Returns number

write

  • write(buffer: Buffer): string
  • Parameters

    Returns string

StringDecoder

StringDecoder: object

Type declaration

  • constructor: function
    • new __type(encoding: string): __type
    • Parameters

      • encoding: string

      Returns __type

"tls"

"tls":

ClearTextStream

ClearTextStream:

constructor

address

address: object

Type declaration

  • address: string
  • family: string
  • port: number

authorizationError

authorizationError: Error

authorized

authorized: boolean

getCipher

getCipher: object

Type declaration

  • name: string
  • version: string

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

getPeerCertificate

  • getPeerCertificate(): any
  • Returns any

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ConnectionOptions

ConnectionOptions:

NPNProtocols

NPNProtocols: any

ca

ca: any

cert

cert: any

host

host: string

key

key: any

passphrase

passphrase: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

servername

servername: string

socket

socket: Socket

SecureContext

SecureContext:

context

context: any

SecureContextOptions

SecureContextOptions:

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

SecurePair

SecurePair:

cleartext

cleartext: any

encrypted

encrypted: any

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

TlsOptions

TlsOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: any

host

host: string

key

key: any

passphrase

passphrase: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

CLIENT_RENEG_LIMIT

CLIENT_RENEG_LIMIT: number

CLIENT_RENEG_WINDOW

CLIENT_RENEG_WINDOW: number

connect

  • Parameters

    • options: TlsOptions
    • Optional secureConnectionListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional host: string
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

createSecureContext

createSecurePair

  • createSecurePair(credentials?: Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair
  • Parameters

    • Optional credentials: Credentials
    • Optional isServer: boolean
    • Optional requestCert: boolean
    • Optional rejectUnauthorized: boolean

    Returns SecurePair

createServer

  • createServer(options: TlsOptions, secureConnectionListener?: function): Server
  • Parameters

    Returns Server

"tty"

"tty":

ReadStream

ReadStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

isRaw

isRaw: boolean

isTTY

isTTY: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setRawMode

  • setRawMode(mode: boolean): void
  • Parameters

    • mode: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

WriteStream

WriteStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

columns

columns: number

isTTY

isTTY: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

rows

rows: number

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

isatty

  • isatty(fd: number): boolean
  • Parameters

    • fd: number

    Returns boolean

"url"

"url":

Url

Url:

auth

auth: string

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

slashes

slashes: boolean

format

  • format(url: Url): string
  • Parameters

    Returns string

parse

  • parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url
  • Parameters

    • urlStr: string
    • Optional parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

resolve

  • resolve(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

"util"

"util":

InspectOptions

InspectOptions:

colors

colors: boolean

customInspect

customInspect: boolean

depth

depth: number

showHidden

showHidden: boolean

debug

  • debug(string: string): void
  • Parameters

    • string: string

    Returns void

debuglog

  • debuglog(key: string): function
  • Parameters

    • key: string

    Returns function

      • (msg: string, ...param: any[]): void
      • Parameters

        • msg: string
        • Rest ...param: any[]

        Returns void

error

  • error(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

format

  • format(format: any, ...param: any[]): string
  • Parameters

    • format: any
    • Rest ...param: any[]

    Returns string

inherits

  • inherits(constructor: any, superConstructor: any): void
  • Parameters

    • constructor: any
    • superConstructor: any

    Returns void

inspect

  • inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string
  • inspect(object: any, options: InspectOptions): string
  • Parameters

    • object: any
    • Optional showHidden: boolean
    • Optional depth: number
    • Optional color: boolean

    Returns string

  • Parameters

    Returns string

isArray

  • isArray(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isDate

  • isDate(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isError

  • isError(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isRegExp

  • isRegExp(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

log

  • log(string: string): void
  • Parameters

    • string: string

    Returns void

print

  • print(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

puts

  • puts(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

"vm"

"vm":

Context

Context:

Script

Script:

runInNewContext

  • runInNewContext(sandbox?: Context): void
  • Parameters

    Returns void

runInThisContext

  • runInThisContext(): void
  • Returns void

createContext

  • Parameters

    Returns Context

createScript

  • createScript(code: string, filename?: string): Script
  • Parameters

    • code: string
    • Optional filename: string

    Returns Script

runInContext

  • runInContext(code: string, context: Context, filename?: string): void
  • Parameters

    • code: string
    • context: Context
    • Optional filename: string

    Returns void

runInNewContext

  • runInNewContext(code: string, sandbox?: Context, filename?: string): void
  • Parameters

    • code: string
    • Optional sandbox: Context
    • Optional filename: string

    Returns void

runInThisContext

  • runInThisContext(code: string, filename?: string): void
  • Parameters

    • code: string
    • Optional filename: string

    Returns void

"zlib"

"zlib":

Deflate

Deflate:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DeflateRaw

DeflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gunzip

Gunzip:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gzip

Gzip:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Inflate

Inflate:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

InflateRaw

InflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Unzip

Unzip:

constructor

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: any, encoding: string, callback: Function): void
  • Parameters

    • chunk: any
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: any, cb?: Function): void
  • end(chunk: any, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: any): void
  • Parameters

    • chunk: any

    Returns void

wrap

write

  • write(chunk: any, cb?: Function): boolean
  • write(chunk: any, encoding?: string, cb?: Function): boolean
  • Parameters

    • chunk: any
    • Optional cb: Function

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ZlibOptions

ZlibOptions:

chunkSize

chunkSize: number

dictionary

dictionary: any

level

level: number

memLevel

memLevel: number

strategy

strategy: number

windowBits

windowBits: number

Z_ASCII

Z_ASCII: number

Z_BEST_COMPRESSION

Z_BEST_COMPRESSION: number

Z_BEST_SPEED

Z_BEST_SPEED: number

Z_BINARY

Z_BINARY: number

Z_BLOCK

Z_BLOCK: number

Z_BUF_ERROR

Z_BUF_ERROR: number

Z_DATA_ERROR

Z_DATA_ERROR: number

Z_DEFAULT_COMPRESSION

Z_DEFAULT_COMPRESSION: number

Z_DEFAULT_STRATEGY

Z_DEFAULT_STRATEGY: number

Z_DEFLATED

Z_DEFLATED: number

Z_ERRNO

Z_ERRNO: number

Z_FILTERED

Z_FILTERED: number

Z_FINISH

Z_FINISH: number

Z_FIXED

Z_FIXED: number

Z_FULL_FLUSH

Z_FULL_FLUSH: number

Z_HUFFMAN_ONLY

Z_HUFFMAN_ONLY: number

Z_MEM_ERROR

Z_MEM_ERROR: number

Z_NEED_DICT

Z_NEED_DICT: number

Z_NO_COMPRESSION

Z_NO_COMPRESSION: number

Z_NO_FLUSH

Z_NO_FLUSH: number

Z_NULL

Z_NULL: number

Z_OK

Z_OK: number

Z_PARTIAL_FLUSH

Z_PARTIAL_FLUSH: number

Z_RLE

Z_RLE: number

Z_STREAM_END

Z_STREAM_END: number

Z_STREAM_ERROR

Z_STREAM_ERROR: number

Z_SYNC_FLUSH

Z_SYNC_FLUSH: number

Z_TEXT

Z_TEXT: number

Z_TREES

Z_TREES: number

Z_UNKNOWN

Z_UNKNOWN: number

Z_VERSION_ERROR

Z_VERSION_ERROR: number

createDeflate

  • Parameters

    Returns Deflate

createDeflateRaw

  • Parameters

    Returns DeflateRaw

createGunzip

  • Parameters

    Returns Gunzip

createGzip

  • Parameters

    Returns Gzip

createInflate

  • Parameters

    Returns Inflate

createInflateRaw

  • Parameters

    Returns InflateRaw

createUnzip

  • Parameters

    Returns Unzip

deflate

  • deflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRaw

  • deflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRawSync

  • Parameters

    Returns any

deflateSync

  • Parameters

    Returns any

gunzip

  • gunzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gunzipSync

  • Parameters

    Returns any

gzip

  • gzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gzipSync

  • Parameters

    Returns any

inflate

  • inflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRaw

  • inflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRawSync

  • Parameters

    Returns any

inflateSync

  • Parameters

    Returns any

unzip

  • unzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

unzipSync

  • Parameters

    Returns any

NodeJS

NodeJS:
                                          *
          GLOBAL INTERFACES               *
                                          *

ErrnoException

ErrnoException:

Error

Error: ErrorConstructor

code

code: string

errno

errno: number

message

message: string

name

name: string

path

path: string

stack

stack: string

syscall

syscall: string

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number
  • Returns number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • Parameters

    • n: number

    Returns EventEmitter

Global

Global:

Array

Array: ArrayConstructor

ArrayBuffer

ArrayBuffer: ArrayBufferConstructor

Boolean

Boolean: BooleanConstructor

Buffer

Buffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(array: Uint8Array): __type
    • new __type(array: any[]): __type
    • new __type(buffer: Buffer): __type
    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: string

        encoding to use, optional. Default is 'utf8'

      Returns __type

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: any[]

        The octets to store.

      Returns __type

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

      Parameters

      • string: string

        string to test.

      • Optional encoding: string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

  • compare: function
    • The same as buf1.compare(buf2).

      Parameters

      Returns number

  • concat: function
    • Returns a buffer which is the result of concatenating all the buffers in the list together.

      If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

      Parameters

      • list: Buffer[]

        An array of Buffer objects to concatenate

      • Optional totalLength: number

        Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Returns true if {obj} is a Buffer

      Parameters

      • obj: any

        object to test.

      Returns boolean

  • isEncoding: function
    • isEncoding(encoding: string): boolean
    • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

      Parameters

      • encoding: string

        string to test.

      Returns boolean

DataView

DataView: DataViewConstructor

Date

Date: DateConstructor

Error

Error: ErrorConstructor

EvalError

EvalError: EvalErrorConstructor

Float32Array

Float32Array: Float32ArrayConstructor

Float64Array

Float64Array: Float64ArrayConstructor

Function

Function: FunctionConstructor

GLOBAL

GLOBAL: Global

Infinity

Infinity: number

Int16Array

Int16Array: Int16ArrayConstructor

Int32Array

Int32Array: Int32ArrayConstructor

Int8Array

Int8Array: Int8ArrayConstructor

Intl

Intl: Intl

JSON

JSON: JSON

Map

Map: MapConstructor

Math

Math: Math

NaN

NaN: number

Number

Number: NumberConstructor

Object

Object: ObjectConstructor

Promise

Promise: Function

RangeError

RangeError: RangeErrorConstructor

ReferenceError

ReferenceError: ReferenceErrorConstructor

RegExp

RegExp: RegExpConstructor

Set

Set: SetConstructor

String

String: StringConstructor

Symbol

Symbol: Function

SyntaxError

SyntaxError: SyntaxErrorConstructor

TypeError

TypeError: TypeErrorConstructor

URIError

URIError: URIErrorConstructor

Uint16Array

Uint16Array: Uint16ArrayConstructor

Uint32Array

Uint32Array: Uint32ArrayConstructor

Uint8Array

Uint8Array: Uint8ArrayConstructor

Uint8ClampedArray

Uint8ClampedArray: Function

WeakMap

WeakMap: WeakMapConstructor

WeakSet

WeakSet: WeakSetConstructor

clearImmediate

clearImmediate: function

Type declaration

    • (immediateId: any): void
    • Parameters

      • immediateId: any

      Returns void

clearInterval

clearInterval: function

Type declaration

    • (intervalId: Timer): void
    • Parameters

      Returns void

clearTimeout

clearTimeout: function

Type declaration

    • (timeoutId: Timer): void
    • Parameters

      Returns void

console

console: Console

decodeURI

decodeURI: decodeURI

decodeURIComponent

decodeURIComponent: decodeURIComponent

encodeURI

encodeURI: encodeURI

encodeURIComponent

encodeURIComponent: encodeURIComponent

escape

escape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

eval

eval: eval

gc

gc: function

Type declaration

    • (): void
    • Returns void

global

global: Global

isFinite

isFinite: isFinite

isNaN

isNaN: isNaN

parseFloat

parseFloat: parseFloat

parseInt

parseInt: parseInt

process

process: Process

root

root: Global

setImmediate

setImmediate: function

Type declaration

    • (callback: function, ...args: any[]): any
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Rest ...args: any[]

      Returns any

setInterval

setInterval: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

setTimeout

setTimeout: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

undefined

undefined: any

unescape

unescape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

v8debug

v8debug: any

Process

Process:

arch

arch: string

argv

argv: string[]

config

config: object

Type declaration

  • target_defaults: object
    • cflags: any[]
    • default_configuration: string
    • defines: string[]
    • include_dirs: string[]
    • libraries: string[]
  • variables: object
    • clang: number
    • host_arch: string
    • node_install_npm: boolean
    • node_install_waf: boolean
    • node_prefix: string
    • node_shared_openssl: boolean
    • node_shared_v8: boolean
    • node_shared_zlib: boolean
    • node_use_dtrace: boolean
    • node_use_etw: boolean
    • node_use_openssl: boolean
    • target_arch: string
    • v8_no_strict_aliasing: number
    • v8_use_snapshot: boolean
    • visibility: string

env

env: any

execPath

execPath: string

pid

pid: number

platform

platform: string

stderr

stdin

stdout

title

title: string

version

version: string

versions

versions: object

Type declaration

  • ares: string
  • http_parser: string
  • node: string
  • openssl: string
  • uv: string
  • v8: string
  • zlib: string

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

chdir

  • chdir(directory: string): void
  • Parameters

    • directory: string

    Returns void

cwd

  • cwd(): string
  • Returns string

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

exit

  • exit(code?: number): void
  • Parameters

    • Optional code: number

    Returns void

getMaxListeners

  • getMaxListeners(): number

getgid

  • getgid(): number
  • Returns number

getuid

  • getuid(): number
  • Returns number

hrtime

  • hrtime(time?: number[]): number[]
  • Parameters

    • Optional time: number[]

    Returns number[]

kill

  • kill(pid: number, signal?: string | number): void
  • Parameters

    • pid: number
    • Optional signal: string | number

    Returns void

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

memoryUsage

  • memoryUsage(): object
  • Returns object

    • heapTotal: number
    • heapUsed: number
    • rss: number

nextTick

  • nextTick(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

setgid

  • setgid(id: number): void
  • setgid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

setuid

  • setuid(id: number): void
  • setuid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

umask

  • umask(mask?: number): number
  • Parameters

    • Optional mask: number

    Returns number

uptime

  • uptime(): number
  • Returns number

ReadWriteStream

ReadWriteStream:

readable

readable: boolean

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

ReadableStream

ReadableStream:

readable

readable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

Timer

Timer:

ref

  • ref(): void
  • Returns void

unref

  • unref(): void
  • Returns void

WritableStream

WritableStream:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

write

  • write(buffer: Buffer | string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer | string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Buffer

Buffer:

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): Buffer
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns Buffer

indexOf

  • indexOf(value: string | number | Buffer, byteOffset?: number): number
  • Parameters

    • value: string | number | Buffer
    • Optional byteOffset: number

    Returns number

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

Error

Error:
                                          *
          Node.js v4.x API                *
                                          *

stack

stack: string

MapConstructor

MapConstructor:

NodeBuffer

NodeBuffer:
deprecated

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): Buffer
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns Buffer

indexOf

  • indexOf(value: string | number | Buffer, byteOffset?: number): number
  • Parameters

    • value: string | number | Buffer
    • Optional byteOffset: number

    Returns number

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

NodeModule

NodeModule:

children

children: any[]

exports

exports: any

filename

filename: string

id

id: string

loaded

loaded: boolean

parent

parent: any

require

NodeRequire

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

cache

cache: any

extensions

extensions: any

main

main: any

resolve

  • resolve(id: string): string
  • Parameters

    • id: string

    Returns string

NodeRequireFunction

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

SetConstructor

SetConstructor:

WeakMapConstructor

WeakMapConstructor:

WeakSetConstructor

WeakSetConstructor:

SlowBuffer

SlowBuffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(size: Uint8Array): __type
    • new __type(array: any[]): __type
    • Parameters

      • str: string
      • Optional encoding: string

      Returns __type

    • Parameters

      • size: number

      Returns __type

    • Parameters

      • size: Uint8Array

      Returns __type

    • Parameters

      • array: any[]

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function
    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Parameters

      • obj: any

      Returns boolean

___dirname

___dirname: string

___filename

___filename: string

exports

exports: any

global

global: Global

module

module: NodeModule

process

process: Process
                                          *
              GLOBAL                      *
                                          *

require

require: NodeRequire

clearImmediate

  • clearImmediate(immediateId: any): void
  • Parameters

    • immediateId: any

    Returns void

clearInterval

  • clearInterval(intervalId: Timer): void
  • Parameters

    Returns void

clearTimeout

  • clearTimeout(timeoutId: Timer): void
  • Parameters

    Returns void

setImmediate

  • setImmediate(callback: function, ...args: any[]): any
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

    Returns any

setInterval

  • setInterval(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

setTimeout

  • setTimeout(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

"typings/main/ambient/request/index.d"

"typings/main/ambient/request/index.d":

"request"

"request":

request

request:

AWSOptions

AWSOptions:

bucket

bucket: string

secret

secret: string

AuthOptions

AuthOptions:

bearer

bearer: string

pass

pass: string

password

password: string

sendImmediately

sendImmediately: boolean

user

user: string

username

username: string

Cookie

Cookie:

Array

Array: ArrayConstructor

expires

expires: Date

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

path

path: string

str

str: string

__@iterator

  • Iterator

    Returns IterableIterator<CookieValue>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

    • copyWithin: boolean
    • entries: boolean
    • fill: boolean
    • find: boolean
    • findIndex: boolean
    • keys: boolean
    • values: boolean

concat

  • Combines two or more arrays.

    Type parameters

    Parameters

    • Rest ...items: U[]

      Additional items to add to the end of array1.

    Returns CookieValue[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: CookieValue[]

      Additional items to add to the end of array1.

    Returns CookieValue[]

constructor

  • constructor(name: string, req: Request): void
  • Parameters

    Returns void

copyWithin

  • copyWithin(target: number, start: number, end?: number): CookieValue[]
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

      If not specified, length of the this object is used as its default value.

    Returns CookieValue[]

entries

  • Returns an array of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CookieValue]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CookieValue

      value to fill array section with

    • Optional start: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns CookieValue[]

filter

  • filter(callbackfn: function, thisArg?: any): CookieValue[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CookieValue[]

find

  • find(predicate: function, thisArg?: any): CookieValue
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns CookieValue

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: CookieValue, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CookieValue

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an list of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CookieValue, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CookieValue

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns CookieValue

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CookieValue[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function, initialValue?: CookieValue): CookieValue
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: CookieValue

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns CookieValue

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function, initialValue?: CookieValue): CookieValue
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: CookieValue

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns CookieValue

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns CookieValue[]

shift

  • Removes the first element from an array and returns it.

    Returns CookieValue

slice

  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns CookieValue[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns CookieValue[]

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    Returns CookieValue[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CookieValue[]

      Elements to insert into the array in place of the deleted elements.

    Returns CookieValue[]

toLocaleString

  • toLocaleString(): string
  • Returns string

toString

  • toString(): string
  • Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CookieValue[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an list of values in the array

    Returns IterableIterator<CookieValue>

CookieJar

CookieJar:

getCookieString

  • getCookieString(uri: string | Url): string
  • Parameters

    • uri: string | Url

    Returns string

getCookies

  • Parameters

    • uri: string | Url

    Returns Cookie[]

setCookie

  • setCookie(cookie: Cookie, uri: string | Url, options?: any): void
  • Parameters

    • cookie: Cookie
    • uri: string | Url
    • Optional options: any

    Returns void

CookieValue

CookieValue:

httpOnly

httpOnly: boolean

name

name: string

value

value: any

CoreOptions

CoreOptions:

agentClass

agentClass: any

agentOptions

agentOptions: any

auth

aws

baseUrl

baseUrl: string

body

body: any

ca

ca: Buffer

callback

callback: function

Type declaration

cert

cert: Buffer

encoding

encoding: string

followAllRedirects

followAllRedirects: boolean

followRedirect

followRedirect: boolean | function

forever

forever: any

form

form: any

formData

formData: any

gzip

gzip: boolean

har

hawk

headers

headers: Headers

host

host: string

jar

jar: any

json

json: any

key

key: Buffer

maxRedirects

maxRedirects: number

method

method: string

multipart

multipart: RequestPart[] | Multipart

oauth

passphrase

passphrase: string

pool

pool: any

port

port: number

postambleCRLF

postambleCRLF: boolean

preambleCRLF

preambleCRLF: boolean

proxy

proxy: any

qs

qs: any

strictSSL

strictSSL: boolean

timeout

timeout: number

useQuerystring

useQuerystring: boolean

DefaultUriUrlRequestApi

  • __call(): TRequest
  • __call(uri: string, options?: TOptions, callback?: RequestCallback): TRequest
  • __call(uri: string, callback?: RequestCallback): TRequest
  • __call(options: TUriUrlOptions & TOptions, callback?: RequestCallback): TRequest
  • Returns TRequest

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

debug

debug: boolean

initParams

initParams: any

cookie

  • Parameters

    • str: string

    Returns Cookie

defaults

del

  • del(): TRequest
  • Returns TRequest

forever

  • forever(agentOptions: any, optionsArg: any): TRequest
  • Parameters

    • agentOptions: any
    • optionsArg: any

    Returns TRequest

get

  • get(): TRequest
  • Returns TRequest

head

  • head(): TRequest
  • Returns TRequest

jar

patch

  • patch(): TRequest
  • Returns TRequest

post

  • post(): TRequest
  • Returns TRequest

put

  • put(): TRequest
  • Returns TRequest

HawkOptions

HawkOptions:

credentials

credentials: any

Headers

Headers:

HttpArchiveRequest

HttpArchiveRequest:

headers

headers: NameValuePair[]

method

method: string

postData

postData: object

Type declaration

url

url: string

Multipart

Multipart:

chunked

chunked: boolean

data

data: object[]

Type declaration

  • body: string
  • Optional content-type?: string

NameValuePair

NameValuePair:

name

name: string

value

value: string

OAuthOptions

OAuthOptions:

callback

callback: string

consumer_key

consumer_key: string

consumer_secret

consumer_secret: string

token

token: string

token_secret

token_secret: string

verifier

verifier: string

OptionalUriUrl

OptionalUriUrl:

uri

uri: string

url

url: string

Request

Request:

readable

readable: boolean

writable

writable: boolean

EventEmitter

EventEmitter: EventEmitter

defaultMaxListeners

defaultMaxListeners: number

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

auth

  • auth(username: string, password: string, sendInmediately?: boolean, bearer?: string): Request
  • Parameters

    • username: string
    • password: string
    • Optional sendInmediately: boolean
    • Optional bearer: string

    Returns Request

aws

  • Parameters

    Returns Request

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(chunk: Buffer, cb?: Function): void
  • end(chunk: string, cb?: Function): void
  • end(chunk: string, encoding: string, cb?: Function): void
  • Returns void

  • Parameters

    • chunk: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: string
    • Optional cb: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • Optional cb: Function

    Returns void

form

  • Returns FormData

  • Parameters

    • form: any

    Returns Request

getAgent

  • Returns Agent

getMaxListeners

  • getMaxListeners(): number

jar

  • Parameters

    Returns Request

json

  • Parameters

    • val: any

    Returns Request

listenerCount

  • listenerCount(type: string): number
  • Parameters

    • type: string

    Returns number

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

multipart

  • Parameters

    Returns Request

oauth

  • Parameters

    Returns Request

on

  • on(event: string, listener: Function): Request
  • on(event: "request", listener: function): Request
  • on(event: "response", listener: function): Request
  • on(event: "data", listener: function): Request
  • on(event: "error", listener: function): Request
  • on(event: "complete", listener: function): Request
  • Parameters

    • event: string
    • listener: Function

    Returns Request

  • Parameters

    Returns Request

  • Parameters

    Returns Request

  • Parameters

    • event: "data"
    • listener: function
        • (data: Buffer | string): void
        • Parameters

          Returns void

    Returns Request

  • Parameters

    • event: "error"
    • listener: function
        • (e: Error): void
        • Parameters

          • e: Error

          Returns void

    Returns Request

  • Parameters

    Returns Request

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

pipeDest

  • pipeDest(dest: any): void
  • Parameters

    • dest: any

    Returns void

qs

  • qs(q: Object, clobber?: boolean): Request
  • Parameters

    • q: Object
    • Optional clobber: boolean

    Returns Request

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setHeader

  • setHeader(name: string, value: string, clobber?: boolean): Request
  • Parameters

    • name: string
    • value: string
    • Optional clobber: boolean

    Returns Request

setHeaders

  • Parameters

    Returns Request

setMaxListeners

toJSON

  • toJSON(): Object
  • Returns Object

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

RequestAPI

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

debug

debug: boolean

initParams

initParams: any

cookie

  • Parameters

    • str: string

    Returns Cookie

defaults

  • Parameters

    • options: TOptions

    Returns RequestAPI<TRequest, TOptions, RequiredUriUrl>

  • Parameters

    • options: (UriOptions | UrlOptions) & TOptions

    Returns DefaultUriUrlRequestApi<TRequest, TOptions, OptionalUriUrl>

del

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

forever

  • forever(agentOptions: any, optionsArg: any): TRequest
  • Parameters

    • agentOptions: any
    • optionsArg: any

    Returns TRequest

get

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

head

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

jar

  • Returns CookieJar

patch

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

post

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

put

  • Parameters

    • uri: string
    • Optional options: TOptions
    • Optional callback: RequestCallback

    Returns TRequest

  • Parameters

    Returns TRequest

  • Parameters

    Returns TRequest

RequestCallback

  • Parameters

    Returns void

RequestPart

RequestPart:

body

body: any

headers

headers: Headers

UriOptions

UriOptions:

uri

uri: string

UrlOptions

UrlOptions:

url

url: string

Options

Options: (UriOptions | UrlOptions) & CoreOptions

RequiredUriUrl

RequiredUriUrl: UriOptions | UrlOptions

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc